CHANGELOG

Unreleased changes

Unreleased changes are documented in files in the changelog.d directory.

0.14.0 — 2023-10-19

Features

  • Added a CloudWatchEMFLogger RequestLifecycleHook class. When attached to an ActionProviderBlueprint, it will emit request count, latency, and response category (2xxs, 4xxs, 5xxs) count metrics through CloudWatch EMF. Metrics are emitted both for the aggregate AP dimension set and the individual route dimension set.

    • Classes may be provided at Blueprint instantiation time to register before, after, and/or teardown functionality wrapping route invocation.

0.13.0rc2 — 2023-10-06

Python support

  • Support Python 3.12.

  • Drop support for Python 3.7.

Development

  • Remove unused dependencies.

Dependencies

  • Raise the minimum Flask version to 2.3.0, which dropped support for Python 3.7.

0.13.0rc1 — 2023-07-24

Changes

  • The minimum pyyaml version is now 6.0

Deprecations

  • Imports from globus_action_provider_tools.flask will no longer emit a DeprecationWarning

Development

  • During local testing, build a shared wheel.

    Previously, a shared .tar.gz file was created. However, in each tox environment, pip would convert this to a wheel during installation.

    This change decreases local test times from ~20 seconds to ~12 seconds.

  • Support running tox test environments in parallel (run tox p).

    This change decreases local test times to only ~3 seconds.

  • Overhaul CI.

    • Introduce caching of the .tox/ and .venv/ directories.

      The cache is invalidated once each week (date %U rolls the week on Sundays).

    • Build a shared wheel once as an artifact and re-use it across all test environments.

    • Consolidate standard testing and testing of minimum Flask versions.

0.13.0b2 — 2022-12-16

Changes

  • Remove an unused parameter from TokenChecker: cache_config.

  • Remove a no-op call to Globus Auth during TokenChecker instantiation.

  • Remove the ConfigurationError class.

0.13.0b1 — 2022-12-14

Python support

  • Add support for Python 3.11.

  • Drop support for Python 3.6.

Bugfixes

  • Fix a crash that will occur if a non-object JSON document is submitted. For example, this will happen if the incoming JSON document is "string" or ["array"].

  • Fix a crash that occurs when an HTTP 400 “invalid grant” error is received from Globus Auth while getting an authorizer for a given scope.

    This is now caught by AuthState.get_authorizer_for_scope() and None is returned.

Changes

  • Remove the __version__ attribute.

    The importlib.metadata module in Python 3.8 and higher (or the backported importlib_metadata package) can be used to query the version of installed packages if needed.

  • jsonschema>=4.17,<5 is now required by action-provider-tools.

    Consumers of the library will have to update to a more recent version of jsonschema if they are using it explicitly.

0.12.0 - 2022-03-02

No changes from 0.12.0b1.

0.12.0b1 - 2022-02-11

Features

  • Upgrade to use major version 3 of the Globus SDK. If you are using Action Provider Tools in an environment which is currently using an earlier version of the Globus SDK, then you will need to upgrade first in order for this version to be compatible.

Bugfixes

  • Fixes an issue where the ActionProviderBlueprint decorators were not returning the decorated functions. This meant that the registered functions were loaded onto the Action Provider correctly but were None in the module in which they were defined.

0.11.5 - 2021-12-13

Documentation

  • Add a CHANGELOG and include it in the documentation.

  • Use scriv for CHANGELOG management.

Added

  • Improved logging around the authentication module’s cache hits and misses.

Fixed

  • Fixed handling of missing refresh tokens in dependent token grants. Now, even if a refresh token is expected in a dependent grant, it falls back to just using the access token up until the time the access token expires. We also shorten the dependent token grant cache to be less than the expected lifetime of an access token and, thus, from cache, we should not retrieve an access token which is already expired.

0.11.4 - 2021-11-01

Features

  • Adds caching to the following Globus Auth operations: token introspection, group membership, dependent token grants.

Documentation

0.11.3 - 2021-05-27

Features

  • Bumps globus-sdk version dependency.

0.11.2 - 2021-05-21

Features

  • Logs authentication errors when a token fails introspection or token validation.

Bugfixes

  • Updates pydantic version to address CVE-2021-29510

0.11.1 - 2021-04-30

Features

  • Allows the detail field to be a string.

  • Improves logging output in the case where there is an Action Provider throws Exceptions or an authentication issue.

  • Allows for environment variable configuration.

  • Bundles Flask an an optional dependency. See the README.md for information on installing the toolkit with Flask.

  • Stabilizes package API.

Bugfixes

  • Updates serialization to output timezone aware datatime objects

  • Updates the return type for Action Resume operations to allow for status codes to be returned from the route.

  • Cleanly separates the Flask HTTP components from the plain Python components.

Deprecations

  • The Flask Callback Loader Helper is now deprecated in favor of the Flask Blueprint Helper.

0.11.0 - 2021-03-29

Features

  • Provide helpers to standardize output formats for INACTIVE and FAILED states

  • Adds a new resume operation to the helpers which is used to signal that an INACTIVE Action may be resumed.

0.10.5 - 2021-01-27

Features

  • Adds exceptions that can be raised from Flask views to return standardized JSON responses.

  • Adds support for Action Provider schema definitions based on Pydantic.

  • Migrates ActionStatus, ActionRequest, and ActionProviderDescription to Pydantic classes.

Bugfixes

  • Modifies ActionProvider introspection endpoint creation on the ActionProviderBlueprint so that HTTP requests with and without trailing slashes receive the same results.

Documentation

0.10.4 - 2020-10-14

Features

  • Improves testing tools for isolating tests between different instances of ActionProviderBlueprints and the Flask helpers.

0.10.3 - 2020-10-01

Features

  • Adds a shared patch to the testing library to mock out an ActionProviderBlueprints TokenChecker

  • Users can now specify a Globus Auth Client Name (legacy) when creating an instance of the ActionProviderBlueprint

  • Users can now specify multiple acceptable scopes when creating an instance of the ActionProviderBlueprint

Bugfixes

  • Fixes an issue in the ActionProviderBlueprint where registering multiple Blueprints on a Flask app would only register one set of routes