Merge pull request #773 from guardian/aa-rm-circular-deps

fix: Remove circular dependencies

package.json

@@ -27,7 +27,7 @@
     "cli:dev": "ts-node src/bin/index.ts"
   },
   "devDependencies": {
-    "@guardian/eslint-config-typescript": "^0.6.1",
+    "@guardian/eslint-config-typescript": "0.7.0",
     "@types/aws-lambda": "^8.10.83",
     "@types/git-url-parse": "^9.0.1",
     "@types/jest": "^27.0.1",

src/constructs/core/migrating.test.ts

@@ -3,7 +3,7 @@ import { SynthUtils } from "@aws-cdk/assert";
 import { Bucket } from "@aws-cdk/aws-s3";
 import type { BucketProps } from "@aws-cdk/aws-s3";
 import { Annotations } from "@aws-cdk/core";
-import type { GuStatefulConstruct } from "../../utils/mixin";
+import type { GuStatefulConstruct } from "../../types/migrating";
 import { simpleGuStackForTesting } from "../../utils/test";
 import type { SynthedStack } from "../../utils/test";
 import { GuMigratingResource } from "./migrating";

src/constructs/core/migrating.ts

@@ -1,23 +1,7 @@
 import { Annotations } from "@aws-cdk/core";
 import type { CfnElement, IConstruct } from "@aws-cdk/core";
-import { isGuStatefulConstruct } from "../../utils/mixin";
-
-export interface GuMigratingStack {
-  /**
-   * A flag to symbolise if a stack is being migrated from a previous format (eg YAML) into guardian/cdk.
-   * A value of `true` means resources in the stack can have custom logicalIds set using the property `existingLogicalId` (where available).
-   * A value of `false` or `undefined` means the stack is brand new. Any resource that gets created will have an auto-generated logicalId.
-   * Ideally, for use only by [[ `GuStack` ]].
-   * @see GuMigratingResource
-   * @see GuStack
-   */
-  migratedFromCloudFormation: boolean;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types -- user defined type guard
-export function isGuMigratingStack(construct: any): construct is GuMigratingStack {
-  return "migratedFromCloudFormation" in construct;
-}
+import type { GuMigratingStack } from "../../types/migrating";
+import { isGuStatefulConstruct } from "../../types/migrating";
 
 export interface GuMigratingResource {
   /**

src/constructs/core/parameters/anghammarad.ts

@@ -1,5 +1,5 @@
 import { SSM_PARAMETER_PATHS } from "../../../constants/ssm-parameter-paths";
-import { isSingletonPresentInStack } from "../../../utils/test";
+import { isSingletonPresentInStack } from "../../../utils/singleton";
 import type { GuStack } from "../stack";
 import { GuStringParameter } from "./base";
 

src/constructs/core/parameters/identity.ts

@@ -1,5 +1,5 @@
 import { Stage, Stages } from "../../../constants";
-import { isSingletonPresentInStack } from "../../../utils/test";
+import { isSingletonPresentInStack } from "../../../utils/singleton";
 import type { GuStack } from "../stack";
 import { GuStringParameter } from "./base";
 

src/constructs/core/parameters/log-shipping.ts

@@ -1,5 +1,5 @@
 import { SSM_PARAMETER_PATHS } from "../../../constants/ssm-parameter-paths";
-import { isSingletonPresentInStack } from "../../../utils/test";
+import { isSingletonPresentInStack } from "../../../utils/singleton";
 import type { GuStack } from "../stack";
 import { GuStringParameter } from "./base";
 

src/constructs/core/parameters/s3.ts

@@ -1,5 +1,5 @@
 import { SSM_PARAMETER_PATHS } from "../../../constants/ssm-parameter-paths";
-import { isSingletonPresentInStack } from "../../../utils/test";
+import { isSingletonPresentInStack } from "../../../utils/singleton";
 import type { GuStack } from "../stack";
 import { GuStringParameter } from "./base";
 

src/constructs/core/parameters/vpc.ts

@@ -1,5 +1,5 @@
 import { SSM_PARAMETER_PATHS } from "../../../constants/ssm-parameter-paths";
-import { isSingletonPresentInStack } from "../../../utils/test";
+import { isSingletonPresentInStack } from "../../../utils/singleton";
 import type { GuStack } from "../stack";
 import { GuParameter } from "./base";
 import type { GuNoTypeParameterProps } from "./base";

src/constructs/core/stack.ts

@@ -6,11 +6,11 @@ import { Stage } from "../../constants";
 import { ContextKeys } from "../../constants/context-keys";
 import { TagKeys } from "../../constants/tag-keys";
 import { TrackingTag } from "../../constants/tracking-tag";
+import type { GuMigratingStack } from "../../types/migrating";
 import { Logger } from "../../utils/logger";
 import type { StackStageIdentity } from "./identity";
 import { GuStageMapping } from "./mappings";
 import type { GuStageDependentValue } from "./mappings";
-import type { GuMigratingStack } from "./migrating";
 import { GuStageParameter } from "./parameters";
 import type { GuParameter } from "./parameters";
 

src/constructs/ec2/security-groups/wazuh.ts

@@ -1,6 +1,6 @@
 import { Peer } from "@aws-cdk/aws-ec2";
 import type { IVpc } from "@aws-cdk/aws-ec2";
-import { isSingletonPresentInStack } from "../../../utils/test";
+import { isSingletonPresentInStack } from "../../../utils/singleton";
 import type { GuStack } from "../../core";
 import { GuMigratingResource } from "../../core/migrating";
 import { GuBaseSecurityGroup } from "./base";

src/constructs/iam/policies/anghammarad.ts

@@ -1,4 +1,4 @@
-import { isSingletonPresentInStack } from "../../../utils/test";
+import { isSingletonPresentInStack } from "../../../utils/singleton";
 import type { GuStack } from "../../core";
 import { GuAnghammaradTopicParameter } from "../../core";
 import { GuAllowPolicy } from "./base-policy";

src/constructs/iam/policies/describe-ec2.ts

@@ -1,5 +1,5 @@
 import { Effect, PolicyStatement } from "@aws-cdk/aws-iam";
-import { isSingletonPresentInStack } from "../../../utils/test";
+import { isSingletonPresentInStack } from "../../../utils/singleton";
 import type { GuStack } from "../../core";
 import { GuPolicy } from "./base-policy";
 

src/constructs/iam/policies/log-shipping.ts

@@ -1,4 +1,4 @@
-import { isSingletonPresentInStack } from "../../../utils/test";
+import { isSingletonPresentInStack } from "../../../utils/singleton";
 import type { GuStack } from "../../core";
 import { GuLoggingStreamNameParameter } from "../../core/parameters/log-shipping";
 import { GuAllowPolicy } from "./base-policy";

src/constructs/iam/policies/ssm.ts

@@ -1,4 +1,4 @@
-import { isSingletonPresentInStack } from "../../../utils/test";
+import { isSingletonPresentInStack } from "../../../utils/singleton";
 import type { GuStack } from "../../core";
 import { GuAllowPolicy } from "./base-policy";
 

src/types/migrating.ts

@@ -0,0 +1,29 @@
+export interface GuMigratingStack {
+  /**
+   * A flag to symbolise if a stack is being migrated from a previous format (eg YAML) into guardian/cdk.
+   * A value of `true` means resources in the stack can have custom logicalIds set using the property `existingLogicalId` (where available).
+   * A value of `false` or `undefined` means the stack is brand new. Any resource that gets created will have an auto-generated logicalId.
+   * Ideally, for use only by [[ `GuStack` ]].
+   * @see GuMigratingResource
+   * @see GuStack
+   */
+  migratedFromCloudFormation: boolean;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types -- user defined type guard
+export function isGuMigratingStack(construct: any): construct is GuMigratingStack {
+  return "migratedFromCloudFormation" in construct;
+}
+
+export interface GuStatefulConstruct {
+  /**
+   * A flag to signal to `GuMigratingResource` that a construct is stateful and care should be taken when migrating to GuCDK.
+   * If one accidentally replaces a stateful resource, downstream services such as DNS may be impacted.
+   */
+  isStatefulConstruct: true;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types -- user defined type guard
+export function isGuStatefulConstruct(construct: any): construct is GuStatefulConstruct {
+  return "isStatefulConstruct" in construct;
+}

src/utils/mixin/migratable-construct-stateful.ts

@@ -1,19 +1,7 @@
+import type { GuStatefulConstruct } from "../../types/migrating";
 import { GuMigratableConstruct } from "./migratable-construct";
 import type { AnyConstructor } from "./types";
 
-export interface GuStatefulConstruct {
-  /**
-   * A flag to signal to `GuMigratingResource` that a construct is stateful and care should be taken when migrating to GuCDK.
-   * If one accidentally replaces a stateful resource, downstream services such as DNS may be impacted.
-   */
-  isStatefulConstruct: true;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types -- user defined type guard
-export function isGuStatefulConstruct(construct: any): construct is GuStatefulConstruct {
-  return "isStatefulConstruct" in construct;
-}
-
 /**
  * A mixin to add the property `isStatefulConstruct` to a class and execute logic to conditionally override a construct's logicalId when synthesised.
  *

src/utils/mixin/migratable-construct.ts

@@ -1,6 +1,7 @@
 import { Construct } from "@aws-cdk/core";
-import { GuMigratingResource, isGuMigratingStack } from "../../constructs/core/migrating";
-import type { GuMigratingStack } from "../../constructs/core/migrating";
+import { GuMigratingResource } from "../../constructs/core/migrating";
+import type { GuMigratingStack } from "../../types/migrating";
+import { isGuMigratingStack } from "../../types/migrating";
 import type { AnyConstructor } from "./types";
 
 /**

src/utils/test/singleton.ts → src/utils/singleton.ts

@@ -1,5 +1,5 @@
 import type { Stack } from "@aws-cdk/core/lib/stack";
-import type { GuStack } from "../../constructs/core";
+import type { GuStack } from "../constructs/core";
 
 /**
  * Check if an element exists in a [[`GuStack`]].

src/utils/test/index.ts

@@ -1,4 +1,3 @@
 export * from "./simple-gu-stack";
 export * from "./synthed-stack";
 export * from "./attach-policy-to-test-role";
-export * from "./singleton";

tools/integration-test/package.json

@@ -16,7 +16,7 @@
     "generate": "cdk synth --path-metadata false --version-reporting false"
   },
   "devDependencies": {
-    "@guardian/eslint-config-typescript": "^0.6.0",
+    "@guardian/eslint-config-typescript": "0.7.0",
     "@types/jest": "^27.0.1",
     "@types/node": "16.7.10",
     "aws-cdk": "1.120.0",