fix: disable transaction extensions by default (#136)

* fix: disable transaction extensions by default

Author: hrodmn

integration_tests/cdk/app.py

@@ -81,7 +81,7 @@ def __init__(
             instance_type=aws_ec2.InstanceType(app_config.db_instance_type),
             add_pgbouncer=True,
             removal_policy=RemovalPolicy.DESTROY,
-            pgstac_version="0.9.2",
+            pgstac_version="0.9.5",
         )
 
         assert pgstac_db.security_group

lib/stac-api/index.ts

@@ -8,11 +8,37 @@ import {
   Duration,
   aws_logs,
 } from "aws-cdk-lib";
-import { IDomainName, HttpApi, ParameterMapping, MappingValue} from "@aws-cdk/aws-apigatewayv2-alpha";
+import {
+  IDomainName,
+  HttpApi,
+  ParameterMapping,
+  MappingValue,
+} from "@aws-cdk/aws-apigatewayv2-alpha";
 import { HttpLambdaIntegration } from "@aws-cdk/aws-apigatewayv2-integrations-alpha";
 import { Construct } from "constructs";
 import { CustomLambdaFunctionProps } from "../utils";
-import * as path from 'path';
+import * as path from "path";
+
+export const EXTENSIONS = {
+  QUERY: "query",
+  SORT: "sort",
+  FIELDS: "fields",
+  FILTER: "filter",
+  FREE_TEXT: "free_text",
+  PAGINATION: "pagination",
+  COLLECTION_SEARCH: "collection_search",
+  TRANSACTION: "transaction",
+  BULK_TRANSACTION: "bulk_transactions",
+} as const;
+
+type ExtensionType = (typeof EXTENSIONS)[keyof typeof EXTENSIONS];
+
+/**
+ * Validates if a given string is a valid STAC extension
+ */
+function isValidExtension(value: string): value is ExtensionType {
+  return Object.values(EXTENSIONS).includes(value as any);
+}
 
 export class PgStacApiLambda extends Construct {
   readonly url: string;
@@ -21,16 +47,40 @@ export class PgStacApiLambda extends Construct {
   constructor(scope: Construct, id: string, props: PgStacApiLambdaProps) {
     super(scope, id);
 
+    const defaultExtensions: ExtensionType[] = [
+      EXTENSIONS.QUERY,
+      EXTENSIONS.SORT,
+      EXTENSIONS.FIELDS,
+      EXTENSIONS.FILTER,
+      EXTENSIONS.FREE_TEXT,
+      EXTENSIONS.PAGINATION,
+      EXTENSIONS.COLLECTION_SEARCH,
+    ];
+
+    if (props.enabledExtensions) {
+      for (const ext of props.enabledExtensions) {
+        if (!isValidExtension(ext)) {
+          throw new Error(
+            `Invalid extension: "${ext}". Must be one of: ${Object.values(
+              EXTENSIONS
+            ).join(", ")}`
+          );
+        }
+      }
+    }
+
+    const enabledExtensions = props.enabledExtensions || defaultExtensions;
+
     this.stacApiLambdaFunction = new lambda.Function(this, "lambda", {
       // defaults
       runtime: lambda.Runtime.PYTHON_3_11,
       handler: "handler.handler",
       memorySize: 8192,
       logRetention: aws_logs.RetentionDays.ONE_WEEK,
       timeout: Duration.seconds(30),
-      code: lambda.Code.fromDockerBuild(path.join(__dirname, '..'), {
+      code: lambda.Code.fromDockerBuild(path.join(__dirname, ".."), {
         file: "stac-api/runtime/Dockerfile",
-        buildArgs: { PYTHON_VERSION: '3.11' },
+        buildArgs: { PYTHON_VERSION: "3.11" },
       }),
       vpc: props.vpc,
       vpcSubnets: props.subnetSelection,
@@ -39,28 +89,40 @@ export class PgStacApiLambda extends Construct {
         PGSTAC_SECRET_ARN: props.dbSecret.secretArn,
         DB_MIN_CONN_SIZE: "0",
         DB_MAX_CONN_SIZE: "1",
+        ENABLED_EXTENSIONS: enabledExtensions.join(","),
         ...props.apiEnv,
       },
       // overwrites defaults with user-provided configurable properties
-      ...props.lambdaFunctionOptions
+      ...props.lambdaFunctionOptions,
     });
 
     props.dbSecret.grantRead(this.stacApiLambdaFunction);
 
-    if (props.vpc){
-      this.stacApiLambdaFunction.connections.allowTo(props.db, ec2.Port.tcp(5432), "allow connections from stac-fastapi-pgstac");
+    if (props.vpc) {
+      this.stacApiLambdaFunction.connections.allowTo(
+        props.db,
+        ec2.Port.tcp(5432),
+        "allow connections from stac-fastapi-pgstac"
+      );
     }
 
     const stacApi = new HttpApi(this, `${Stack.of(this).stackName}-stac-api`, {
-      defaultDomainMapping: props.stacApiDomainName ? {
-        domainName: props.stacApiDomainName
-      } : undefined,
+      defaultDomainMapping: props.stacApiDomainName
+        ? {
+            domainName: props.stacApiDomainName,
+          }
+        : undefined,
       defaultIntegration: new HttpLambdaIntegration(
         "integration",
         this.stacApiLambdaFunction,
-        props.stacApiDomainName ? {
-            parameterMapping: new ParameterMapping().overwriteHeader('host', MappingValue.custom(props.stacApiDomainName.name))
-        } : undefined
+        props.stacApiDomainName
+          ? {
+              parameterMapping: new ParameterMapping().overwriteHeader(
+                "host",
+                MappingValue.custom(props.stacApiDomainName.name)
+              ),
+            }
+          : undefined
       ),
     });
 
@@ -102,12 +164,19 @@ export interface PgStacApiLambdaProps {
   /**
    * Custom Domain Name Options for STAC API,
    */
-   readonly stacApiDomainName?: IDomainName;
+  readonly stacApiDomainName?: IDomainName;
+
+  /**
+   * List of STAC API extensions to enable.
+   *
+   * @default - query, sort, fields, filter, free_text, pagniation, collection_search
+   */
+  readonly enabledExtensions?: ExtensionType[];
 
   /**
-     * Can be used to override the default lambda function properties.
-     *
-     * @default - defined in the construct.
-     */
+   * Can be used to override the default lambda function properties.
+   *
+   * @default - defined in the construct.
+   */
   readonly lambdaFunctionOptions?: CustomLambdaFunctionProps;
 }