aws-durable-execution-sdk-python 1.0.0__tar.gz → 1.1.0__tar.gz

aws_durable_execution_sdk_python-1.1.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @yaythomas @wangyb-A

aws_durable_execution_sdk_python-1.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,91 @@
+name: 🐛 Bug Report
+description: Report a bug or unexpected behavior
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting a bug! Please fill out the information below.
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+      placeholder: I expected...
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened?
+      placeholder: Instead, what happened was...
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: Provide steps to reproduce the issue
+      placeholder: |
+        1. 
+        2. 
+        3. 
+    validations:
+      required: true
+
+  - type: input
+    id: sdk-version
+    attributes:
+      label: SDK Version
+      description: What version of the SDK are you using?
+      placeholder: e.g., 1.0.0
+    validations:
+      required: true
+
+  - type: dropdown
+    id: python-version
+    attributes:
+      label: Python Version
+      description: What version of Python are you using?
+      options:
+        - "3.14"
+        - "3.13"
+        - "3.12"
+        - "3.11"
+        - Other (specify in additional context)
+    validations:
+      required: true
+
+  - type: dropdown
+    id: regression
+    attributes:
+      label: Is this a regression?
+      description: Did this work in a previous version?
+      options:
+        - "No"
+        - "Yes"
+    validations:
+      required: true
+
+  - type: input
+    id: worked-version
+    attributes:
+      label: Last Working Version
+      description: If this is a regression, what version did this work in?
+      placeholder: e.g., 0.9.0
+    validations:
+      required: false
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any other context, logs, or screenshots
+      placeholder: Additional information...
+    validations:
+      required: false

aws_durable_execution_sdk_python-1.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://github.com/aws/aws-durable-execution-sdk-python/discussions/new
+    about: Ask a general question about Lambda Powertools

aws_durable_execution_sdk_python-1.1.0/.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,36 @@
+name: 📚 Documentation Issue
+description: Report an issue with documentation
+title: "[Docs]: "
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for helping improve our documentation!
+
+  - type: textarea
+    id: issue
+    attributes:
+      label: Issue
+      description: Describe the documentation issue
+      placeholder: The documentation says... but it should say...
+    validations:
+      required: true
+
+  - type: input
+    id: page
+    attributes:
+      label: Page/Location
+      description: Link to the page or specify where in the docs this occurs
+      placeholder: https://... or README.md section "..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: fix
+    attributes:
+      label: Suggested Fix
+      description: How should this be corrected?
+      placeholder: This could be fixed by...
+    validations:
+      required: false

aws_durable_execution_sdk_python-1.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,57 @@
+name: ✨ Feature Request
+description: Suggest a new feature or enhancement
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to suggest a new feature!
+
+  - type: textarea
+    id: what
+    attributes:
+      label: What would you like?
+      description: Describe the feature you'd like to see
+      placeholder: I would like to...
+    validations:
+      required: true
+
+  - type: textarea
+    id: implementation
+    attributes:
+      label: Possible Implementation
+      description: Suggest how this could be implemented
+      placeholder: This could be implemented by...
+    validations:
+      required: false
+
+  - type: dropdown
+    id: breaking-change
+    attributes:
+      label: Is this a breaking change?
+      options:
+        - "No"
+        - "Yes"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: rfc
+    attributes:
+      label: Does this require an RFC?
+      description: RFC is required when changing existing behavior or for new features that require research
+      options:
+        - "No"
+        - "Yes"
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any other context, examples, or screenshots
+      placeholder: Additional information...
+    validations:
+      required: false

aws_durable_execution_sdk_python-1.1.0/.github/dependabot.yml

@@ -0,0 +1,14 @@
+# Reference: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      # Group updates together, so that they are all applied in a single PR.
+      # Grouped updates are currently in beta and is subject to change.
+      # xref: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups
+      actions-deps:
+        patterns:
+          - "*"

aws_durable_execution_sdk_python-1.1.0/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+permissions:
+  contents: read
+
+on:
+  push:
+
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint-commits:
+    # Note: To re-run `lint-commits` after fixing the PR title, close-and-reopen the PR.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+      - name: Use Node.js
+        uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
+        with:
+          node-version: 22.x
+      - name: Check PR title
+        run: |
+          node "$GITHUB_WORKSPACE/.github/workflows/lintcommit.js"
+
+  build:
+    needs: lint-commits
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11","3.12","3.13","3.14"]
+
+    steps:
+    - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Hatch 
+      run: |
+        python -m pip install hatch==1.15.0
+    - name: static analysis
+      run: hatch fmt --check
+    - name: type checking
+      run: hatch run types:check
+    - name: Run tests + coverage
+      run: hatch run test:cov
+    - name: Build distribution
+      run: hatch build

aws_durable_execution_sdk_python-1.1.0/.github/workflows/integration-tests.yml

@@ -0,0 +1,184 @@
+name: Integration Tests
+
+on:
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  integration-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.13"]
+
+    steps:
+    - name: Checkout Language SDK (this PR)
+      uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+      with:
+        path: language-sdk
+
+    - name: Parse testing SDK branch from PR body
+      id: parse
+      run: python language-sdk/ops/parse_sdk_branch.py
+      env:
+        PR_BODY: ${{ github.event.pull_request.body }}
+
+    - name: Checkout Testing SDK
+      uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+      with:
+        repository: aws/aws-durable-execution-sdk-python-testing
+        ref: ${{ steps.parse.outputs.testing_ref }}
+        token: ${{ secrets.CROSS_REPO_PAT }}
+        path: testing-sdk
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install Hatch
+      run: python -m pip install hatch==1.15.0
+
+    - name: Setup and run Testing SDK
+      working-directory: testing-sdk
+      env:
+        AWS_DURABLE_SDK_URL: file://${{ github.workspace }}/language-sdk
+      run: |
+        echo "Running Testing SDK tests against Language SDK PR changes..."
+        echo "Using Language SDK from: $AWS_DURABLE_SDK_URL"
+        python -m pip install -e .
+        hatch fmt --check
+        hatch run types:check
+        hatch run test:cov
+        hatch run test:examples
+        hatch build
+
+  e2e-tests:
+    needs: integration-tests
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    env:
+      AWS_REGION: us-west-2
+
+    steps:
+    - name: Checkout Language SDK (this PR)
+      uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+      with:
+        path: language-sdk
+
+    - name: Parse testing SDK branch from PR body
+      id: parse
+      run: python language-sdk/ops/parse_sdk_branch.py
+      env:
+        PR_BODY: ${{ github.event.pull_request.body }}
+
+    - name: Checkout Testing SDK
+      uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+      with:
+        repository: aws/aws-durable-execution-sdk-python-testing
+        ref: ${{ steps.parse.outputs.testing_ref }}
+        token: ${{ secrets.CROSS_REPO_PAT }}
+        path: testing-sdk
+
+    - name: Set up Python 3.13
+      uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6.1.0
+      with:
+        python-version: '3.13'
+
+    - name: Configure AWS credentials
+      uses: aws-actions/configure-aws-credentials@61815dcd50bd041e203e49132bacad1fd04d2708 # v5.1.1
+      with:
+        role-to-assume: "${{ secrets.ACTIONS_INTEGRATION_ROLE_NAME }}"
+        role-session-name: languageSDKIntegrationTest
+        aws-region: ${{ env.AWS_REGION }}
+
+    - name: Install Hatch and setup Testing SDK
+      working-directory: testing-sdk
+      env:
+        AWS_DURABLE_SDK_URL: file://${{ github.workspace }}/language-sdk
+      run: |
+        pip install hatch==1.15.0
+        python -m pip install -e .
+
+    - name: Get integration examples
+      id: get-examples
+      working-directory: testing-sdk/examples
+      run: |
+        echo "examples=$(jq -c '.examples | map(select(.integration == true)) | .[0:2]' examples-catalog.json)" >> $GITHUB_OUTPUT
+
+    - name: Install AWS CLI v2
+      run: |
+        curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "/tmp/awscliv2.zip"
+        unzip -q /tmp/awscliv2.zip -d /tmp
+        rm /tmp/awscliv2.zip
+        sudo /tmp/aws/install --update
+        rm -rf /tmp/aws/
+    - name: Deploy and test examples
+      working-directory: testing-sdk
+      env:
+        AWS_DURABLE_SDK_URL: file://${{ github.workspace }}/language-sdk
+        AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }}
+        LAMBDA_ENDPOINT: ${{ secrets.LAMBDA_ENDPOINT }}
+        INVOKE_ACCOUNT_ID: ${{ secrets.INVOKE_ACCOUNT_ID }}
+        KMS_KEY_ARN: ${{ secrets.KMS_KEY_ARN }}
+      run: |
+        echo "Building examples..."
+        hatch run examples:build
+
+        # Get first integration example for testing
+        EXAMPLE_NAME=$(echo '${{ steps.get-examples.outputs.examples }}' | jq -r '.[0].name')
+        EXAMPLE_NAME_CLEAN=$(echo "$EXAMPLE_NAME" | sed 's/ //g')
+        FUNCTION_NAME="${EXAMPLE_NAME_CLEAN}-LanguageSDK-PR-${{ github.event.number }}"
+
+        echo "Deploying example: $EXAMPLE_NAME as $FUNCTION_NAME"
+        hatch run examples:deploy "$EXAMPLE_NAME" --function-name "$FUNCTION_NAME"
+
+        QUALIFIED_FUNCTION_NAME="$FUNCTION_NAME:\$LATEST"
+
+        echo "Waiting for function to be ready..."
+        aws lambda wait function-active --function-name "$FUNCTION_NAME" --endpoint-url "$LAMBDA_ENDPOINT" --region "${{ env.AWS_REGION }}"
+
+        echo "Invoking Lambda function: $QUALIFIED_FUNCTION_NAME"
+        aws lambda invoke \
+          --function-name "$QUALIFIED_FUNCTION_NAME" \
+          --cli-binary-format raw-in-base64-out \
+          --payload '{"name": "World"}' \
+          --region "${{ env.AWS_REGION }}" \
+          --endpoint-url "$LAMBDA_ENDPOINT" \
+          /tmp/response.json \
+          > /tmp/invoke_response.json
+
+        echo "Response:"
+        cat /tmp/response.json
+
+        # Check for function errors
+        FUNCTION_ERROR=$(jq -r '.FunctionError // empty' /tmp/invoke_response.json)
+        if [ -n "$FUNCTION_ERROR" ]; then
+          echo "ERROR: Lambda function failed with error: $FUNCTION_ERROR"
+          cat /tmp/response.json
+          exit 1
+        fi
+
+        echo "Getting durable executions..."
+        aws lambda list-durable-executions-by-function \
+          --function-name "$QUALIFIED_FUNCTION_NAME" \
+          --statuses SUCCEEDED \
+          --region "${{ env.AWS_REGION }}" \
+          --endpoint-url "$LAMBDA_ENDPOINT" \
+          --cli-binary-format raw-in-base64-out \
+          > /tmp/executions.json
+
+        echo "Durable Executions:"
+        cat /tmp/executions.json
+
+        # Cleanup
+        echo "Cleaning up function: $FUNCTION_NAME"
+        aws lambda delete-function \
+          --function-name "$FUNCTION_NAME" \
+          --endpoint-url "$LAMBDA_ENDPOINT" \
+          --region "${{ env.AWS_REGION }}" || echo "Function cleanup failed or already deleted"

aws_durable_execution_sdk_python-1.1.0/.github/workflows/lintcommit.js

@@ -0,0 +1,178 @@
+// Checks that a PR title conforms to conventional commits
+// (https://www.conventionalcommits.org/).
+//
+// To run self-tests, run this script:
+//
+//     node lintcommit.js test
+
+import { readFileSync, appendFileSync } from "fs";
+
+const types = new Set([
+  "build",
+  "chore",
+  "ci",
+  "config",
+  "deps",
+  "docs",
+  "feat",
+  "fix",
+  "perf",
+  "refactor",
+  "revert",
+  "style",
+  "test",
+  "types",
+]);
+
+const scopes = new Set(["sdk", "examples"]);
+
+/**
+ * Checks that a pull request title, or commit message subject, follows the expected format:
+ *
+ *      type(scope): message
+ *
+ * Returns undefined if `title` is valid, else an error message.
+ */
+function validateTitle(title) {
+  const parts = title.split(":");
+  const subject = parts.slice(1).join(":").trim();
+
+  if (title.startsWith("Merge")) {
+    return undefined;
+  }
+
+  if (parts.length < 2) {
+    return "missing colon (:) char";
+  }
+
+  const typeScope = parts[0];
+
+  const [type, scope] = typeScope.split(/\(([^)]+)\)$/);
+
+  if (/\s+/.test(type)) {
+    return `type contains whitespace: "${type}"`;
+  } else if (!types.has(type)) {
+    return `invalid type "${type}"`;
+  } else if (!scope && typeScope.includes("(")) {
+    return `must be formatted like type(scope):`;
+  } else if (scope && scope.length > 30) {
+    return "invalid scope (must be <=30 chars)";
+  } else if (scope && /[^- a-z0-9]+/.test(scope)) {
+    return `invalid scope (must be lowercase, ascii only): "${scope}"`;
+  } else if (scope && !scopes.has(scope)) {
+    return `invalid scope "${scope}" (valid scopes are ${Array.from(scopes).join(", ")})`;
+  } else if (subject.length === 0) {
+    return "empty subject";
+  } else if (subject.length > 50) {
+    return "invalid subject (must be <=50 chars)";
+  }
+
+  return undefined;
+}
+
+function run() {
+  const eventData = JSON.parse(
+    readFileSync(process.env.GITHUB_EVENT_PATH, "utf8"),
+  );
+  const pullRequest = eventData.pull_request;
+
+  // console.log(eventData)
+
+  if (!pullRequest) {
+    console.info("No pull request found in the context");
+    return;
+  }
+
+  const title = pullRequest.title;
+
+  const failReason = validateTitle(title);
+  const msg = failReason
+    ? `
+Invalid pull request title: \`${title}\`
+
+* Problem: ${failReason}
+* Expected format: \`type(scope): subject...\`
+    * type: one of (${Array.from(types).join(", ")})
+    * scope: optional, lowercase, <30 chars
+    * subject: must be <50 chars
+* Hint: *close and re-open the PR* to re-trigger CI (after fixing the PR title).
+`
+    : `Pull request title matches the expected format`;
+
+  if (process.env.GITHUB_STEP_SUMMARY) {
+    appendFileSync(process.env.GITHUB_STEP_SUMMARY, msg);
+  }
+
+  if (failReason) {
+    console.error(msg);
+    process.exit(1);
+  } else {
+    console.info(msg);
+  }
+}
+
+function _test() {
+  const tests = {
+    " foo(scope): bar": 'type contains whitespace: " foo"',
+    "build: update build process": undefined,
+    "chore: update dependencies": undefined,
+    "ci: configure CI/CD": undefined,
+    "config: update configuration files": undefined,
+    "deps: bump aws-sdk group with 5 updates": undefined,
+    "docs: update documentation": undefined,
+    "feat(sdk): add new feature": undefined,
+    "feat(sdk):": "empty subject",
+    "feat foo):": 'type contains whitespace: "feat foo)"',
+    "feat(foo)): sujet": 'invalid type "feat(foo))"',
+    "feat(foo: sujet": 'invalid type "feat(foo"',
+    "feat(Q Foo Bar): bar":
+      'invalid scope (must be lowercase, ascii only): "Q Foo Bar"',
+    "feat(sdk): bar": undefined,
+    "feat(sdk): x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x x ":
+      "invalid subject (must be <=50 chars)",
+    "feat: foo": undefined,
+    "fix: foo": undefined,
+    "fix(sdk): resolve issue": undefined,
+    "foo (scope): bar": 'type contains whitespace: "foo "',
+    "invalid title": "missing colon (:) char",
+    "perf: optimize performance": undefined,
+    "refactor: improve code structure": undefined,
+    "revert: feat: add new feature": undefined,
+    "style: format code": undefined,
+    "test: add new tests": undefined,
+    "types: add type definitions": undefined,
+    "Merge staging into feature/lambda-get-started": undefined,
+    "feat(foo): fix the types":
+      'invalid scope "foo" (valid scopes are sdk, examples)',
+  };
+
+  let passed = 0;
+  let failed = 0;
+
+  for (const [title, expected] of Object.entries(tests)) {
+    const result = validateTitle(title);
+    if (result === expected) {
+      console.log(`✅ Test passed for "${title}"`);
+      passed++;
+    } else {
+      console.log(
+        `❌ Test failed for "${title}" (expected "${expected}", got "${result}")`,
+      );
+      failed++;
+    }
+  }
+
+  console.log(`\n${passed} tests passed, ${failed} tests failed`);
+}
+
+function main() {
+  const mode = process.argv[2];
+
+  if (mode === "test") {
+    _test();
+  } else {
+    run();
+  }
+}
+
+main();

aws_durable_execution_sdk_python-1.1.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,71 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload PyPI Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
+
+      - uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548  # v6.1.0
+        with:
+          python-version: "3.11"
+      - name: Install Hatch 
+        run: |
+          python -m pip install --upgrade hatch==1.15.0
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          hatch build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4  # v5.0.0
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      # url: https://pypi.org/p/aws-durable-execution-sdk-python
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      url: https://pypi.org/project/aws-durable-execution-sdk-python/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53  # v6.0.0
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # v1.13.0
+        with:
+          packages-dir: dist/