declapract-typescript-ehmpathy 0.49.13 → 0.49.14

package/dist/practices/persist-with-rds/__snapshots__/config-validates-schema.declapract.integration.test.ts.snap

@@ -0,0 +1,500 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case1] a fresh repo when: [t0] the configs and the schema are applied, then applied again then: the configs match snapshot: config/prep.json — after 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prep"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "$.at(aws::param)"
+      }
+    },
+    "tunnel": {
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "awesomesdb"
+      },
+      "local": {
+        "host": "localhost",
+        "port": 15432
+      },
+      "lambda": {
+        "host": "awesomesdb.cluster-abc123.us-east-1.rds.amazonaws.com",
+        "port": 5432
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case1] a fresh repo when: [t0] the configs and the schema are applied, then applied again then: the configs match snapshot: config/prod.json — after 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prod"
+  },
+  "aws": {
+    "account": "222222222222",
+    "namespace": "testns"
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "$.at(aws::param)"
+      }
+    },
+    "tunnel": {
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "awesomesdb"
+      },
+      "local": {
+        "host": "localhost",
+        "port": 15433
+      },
+      "lambda": {
+        "host": "awesomesdb.cluster-def456.us-east-1.rds.amazonaws.com",
+        "port": 5432
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case1] a fresh repo when: [t0] the configs and the schema are applied, then applied again then: the configs match snapshot: config/test.json — after 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "test"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "__CHANG3_ME__"
+      }
+    },
+    "tunnel": {
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "awesomesdb"
+      },
+      "local": {
+        "host": "localhost",
+        "port": 7821
+      },
+      "lambda": null
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/prep.json — after 1`] = `
+"{
+  "@declapract:review": "explicit aws::param paths: copy each value to the derived name /{org}/{project}/{config}/{keyPath}, then swap the explicit path for the bare placeholder (declapract-typescript-ehmpathy#544, see provision/aws/readme.md)",
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prep"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param/test-org/test-project/prep/legacy.plan)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "__CHANG3_ME__"
+      }
+    },
+    "tunnel": {
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "hand-set-cluster"
+      },
+      "local": {
+        "host": "localhost",
+        "port": 15432
+      },
+      "lambda": {
+        "host": "awesomesdb.cluster-abc123.us-east-1.rds.amazonaws.com",
+        "port": 5432
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/prep.json — before 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prep"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param/test-org/test-project/prep/legacy.plan)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "__CHANG3_ME__"
+      }
+    },
+    "tunnel": {
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "hand-set-cluster"
+      },
+      "local": {
+        "host": "localhost",
+        "port": 15432
+      },
+      "lambda": {
+        "host": "cluster.prep.example.com",
+        "port": 5432
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/prod.json — after 1`] = `
+"{
+  "@declapract:review": "explicit aws::param paths: copy each value to the derived name /{org}/{project}/{config}/{keyPath}, then swap the explicit path for the bare placeholder (declapract-typescript-ehmpathy#544, see provision/aws/readme.md)",
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prod"
+  },
+  "aws": {
+    "account": "222222222222",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "$.at(aws::param)"
+      }
+    },
+    "tunnel": {
+      "local": {
+        "host": "localhost",
+        "port": 15433
+      },
+      "lambda": {
+        "host": "awesomesdb.cluster-def456.us-east-1.rds.amazonaws.com",
+        "port": 5432
+      },
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "awesomesdb"
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/prod.json — before 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "prod"
+  },
+  "aws": {
+    "account": "222222222222",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "$.at(aws::param)"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "$.at(aws::param)"
+      }
+    },
+    "tunnel": {
+      "bastion": "vpc-main-bastion",
+      "cluster": "testdb",
+      "local": {
+        "host": "localhost",
+        "port": 15433
+      },
+      "lambda": {
+        "host": "cluster.prod.example.com",
+        "port": 5432
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/test.json — after 1`] = `
+"{
+  "@declapract:review": "explicit aws::param paths: copy each value to the derived name /{org}/{project}/{config}/{keyPath}, then swap the explicit path for the bare placeholder (declapract-typescript-ehmpathy#544, see provision/aws/readme.md)",
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "test"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "__CHANG3_ME__"
+      }
+    },
+    "tunnel": {
+      "local": {
+        "host": "localhost",
+        "port": 7821
+      },
+      "lambda": null,
+      "bastion": {
+        "exid": "vpc-main-bastion"
+      },
+      "cluster": {
+        "name": "awesomesdb"
+      }
+    }
+  }
+}
+"
+`;
+
+exports[`persist-with-rds config validates against config.schema.ts (#638, #683, #519) given: [case2] a repo with hand-set values and legacy string tunnel fields when: [t0] the configs and the schema are applied, then applied again then: before and after match snapshot: config/test.json — before 1`] = `
+"{
+  "organization": "test-org",
+  "project": "test-project",
+  "environment": {
+    "access": "test"
+  },
+  "aws": {
+    "account": "111111111111",
+    "namespace": "testns"
+  },
+  "featureFlags": {
+    "surfReport": true
+  },
+  "database": {
+    "target": {
+      "database": "testdb",
+      "schema": "testdb"
+    },
+    "pool": {
+      "max": 3
+    },
+    "role": {
+      "cicd": {
+        "for-plan": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        },
+        "for-apply": {
+          "username": "cicd_user",
+          "password": "__CHANG3_ME__"
+        }
+      },
+      "crud": {
+        "username": "service_user",
+        "password": "__CHANG3_ME__"
+      }
+    },
+    "tunnel": {
+      "bastion": "vpc-main-bastion",
+      "cluster": "testdb",
+      "local": {
+        "host": "localhost",
+        "port": 7821
+      },
+      "lambda": null
+    }
+  }
+}
+"
+`;

package/dist/practices/persist-with-rds/__snapshots__/database-wrappers-typecheck.declapract.integration.test.ts.snap

@@ -0,0 +1,10 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`persist-with-rds database wrappers type-check where they land (#627, #633) given: [case2] the jsdoc example that withDatabaseContext ships when: [t0] tsc runs over the example, as an adopter would paste it then: the example matches snapshot: withDatabaseContext jsdoc example 1`] = `
+"  const findById = withDatabaseContext(({ id }: { id: string }, context: { dbConnection: DatabaseConnection }) => {
+    // do logic with dbConnection
+  });
+  // ...
+  await findById({ id: '821' }, {}); // the context is required, but the dbConnection within it is not
+  await findById({ id: '821' }, { dbConnection }); // pass one in to reuse it, e.g. inside a transaction"
+`;

package/dist/practices/persist-with-rds/__snapshots__/engine-upgrade.declapract.integration.test.ts.snap

@@ -0,0 +1,151 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case1] a repo on dialect 10.7 with its own testdb pin when: [t0] the input, before any fix then: each file matches snapshot: codegen.sql.dao.yml — before 1`] = `
+"language: postgres
+dialect: 10.7
+generates:
+  daos:
+    to: src/access/daos
+    using:
+      log: src/utils/logger#log
+      DatabaseConnection: src/utils/database/getOneDatabaseConnection#DatabaseConnection
+  schema:
+    config: codegen.sql.schema.yml
+  control:
+    config: provision/schema/control.yml
+  code:
+    config: codegen.sql.types.yml
+for:
+  objects:
+    search:
+      - 'src/domain.objects/*.ts'
+    exclude:
+      - 'SurfReportDraft'
+"
+`;
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case1] a repo on dialect 10.7 with its own testdb pin when: [t0] the input, before any fix then: each file matches snapshot: provision/docker/testdb/build-image.dockerfile — before 1`] = `
+"FROM postgres:17.9
+
+COPY init/ /docker-entrypoint-initdb.d/
+
+ADD wait-for-postgres.sh /root/
+RUN chmod +x /root/wait-for-postgres.sh
+"
+`;
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case1] a repo on dialect 10.7 with its own testdb pin when: [t1] apply runs then: the dao config moves to dialect 17, and keeps its own exclusions: codegen.sql.dao.yml — after 1`] = `
+"language: postgres
+dialect: 17
+generates:
+  daos:
+    to: src/access/daos
+    using:
+      log: src/utils/logger#log
+      DatabaseConnection: src/utils/database/getOneDatabaseConnection#DatabaseConnection
+  schema:
+    config: codegen.sql.schema.yml
+  control:
+    config: provision/schema/control.yml
+  code:
+    config: codegen.sql.types.yml
+for:
+  objects:
+    search:
+      - 'src/domain.objects/*.ts'
+    exclude:
+      - 'SurfReportDraft'
+"
+`;
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case1] a repo on dialect 10.7 with its own testdb pin when: [t1] apply runs then: the testdb keeps the pin the repo chose, and the check passes on it: provision/docker/testdb/build-image.dockerfile — after 1`] = `
+"FROM postgres:17.9
+
+COPY init/ /docker-entrypoint-initdb.d/
+
+ADD wait-for-postgres.sh /root/
+RUN chmod +x /root/wait-for-postgres.sh
+
+"
+`;
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case3] check-engine-skew.sh when: [t0] the testdb leads the livedb then: the check lines match the snapshot 1`] = `
+{
+  "status": 2,
+  "stderr": "✋ ConstraintError: the testdb (postgres 17) leads the livedb (postgres 13)
+   ├─ why: a green suite here can rest on a postgres 17 feature the livedb rejects
+   └─ fix: one of two, by how the skew arrived
+      ├─ the pin moved before the flip: merge after the livedb reads postgres 17
+      └─ the livedb fell back:          pin the testdb to postgres 13 until the flip holds",
+  "stdout": "🔭 engine skew
+   ├─ testdb: postgres 17 (<dockerfile>)
+   └─ livedb: postgres 13.23
+",
+}
+`;
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case3] check-engine-skew.sh when: [t1] the testdb leads a livedb below its declared target then: the check lines match the snapshot 1`] = `
+{
+  "status": 2,
+  "stderr": "✋ ConstraintError: the testdb (postgres 17) leads the livedb (postgres 13)
+   ├─ why: a green suite here can rest on a postgres 17 feature the livedb rejects
+   ├─ how: the livedb sits below its declared target 17 — a flip was reverted, or has not yet applied
+   └─ fix: pin the testdb to postgres 13 until the flip holds. do not re-flip a reverted livedb from here",
+  "stdout": "🔭 engine skew
+   ├─ testdb: postgres 17 (<dockerfile>)
+   └─ livedb: postgres 13.23
+",
+}
+`;
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case3] check-engine-skew.sh when: [t2] the testdb trails the livedb then: the check lines match the snapshot 1`] = `
+{
+  "status": 0,
+  "stderr": "",
+  "stdout": "🔭 engine skew
+   ├─ testdb: postgres 13 (<dockerfile>)
+   └─ livedb: postgres 17.11
+
+::warning title=engine skew::testdb postgres 13 trails the livedb's postgres 17. safe, but bump the pin on the next declapract upgrade
+",
+}
+`;
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case3] check-engine-skew.sh when: [t3] the majors match then: the check lines match the snapshot 1`] = `
+{
+  "status": 0,
+  "stderr": "",
+  "stdout": "🔭 engine skew
+   ├─ testdb: postgres 17 (<dockerfile>)
+   └─ livedb: postgres 17.7
+✨ majors match
+",
+}
+`;
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case3] check-engine-skew.sh when: [t4] the dockerfile has no postgres pin then: the check lines match the snapshot 1`] = `
+{
+  "status": 1,
+  "stderr": "💥 MalfunctionError: no 'FROM postgres:<major>' pin found in <dockerfile>
+   └─ fix: pin a major, like 'FROM postgres:17.11', or pass --dockerfile with the testdb image",
+  "stdout": "",
+}
+`;
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case3] check-engine-skew.sh when: [t5] a flag with no value then: the check lines match the snapshot 1`] = `
+{
+  "status": 2,
+  "stderr": "✋ ConstraintError: --livedb-version needs a value
+   └─ fix: see <check-engine-skew.sh> --help",
+  "stdout": "",
+}
+`;
+
+exports[`persist-with-rds engine upgrade surface (#664) given: [case3] check-engine-skew.sh when: [t6] the livedb read fails then: the check lines match the snapshot 1`] = `
+{
+  "status": 1,
+  "stderr": "💥 MalfunctionError: could not read the engine version of cluster '@declapract{variable.databaseClusterName}'
+   └─ fix: the caller needs aws auth with rds:DescribeDBClusters on the livedb's account",
+  "stdout": "",
+}
+`;

package/dist/practices/persist-with-rds/__snapshots__/ssm-param-names.declapract.integration.test.ts.snap

@@ -0,0 +1,9 @@
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+
+exports[`persist-with-rds ssm param names are the sdk-config derived names (#637) given: [case1] the wish run with ACCESS=prep CONFIG=prep when: [t0] getAllParameters is called with no choice override then: the declared names match snapshot 1`] = `
+[
+  "/@declapract{variable.organizationName}/@declapract{variable.projectName}/prep/database.role.crud.password",
+  "/@declapract{variable.organizationName}/@declapract{variable.projectName}/prep/database.role.cicd.for-plan.password",
+  "/@declapract{variable.organizationName}/@declapract{variable.projectName}/prep/database.role.cicd.for-apply.password",
+]
+`;