v14.0.0

Breaking Changes

• Cumulus dashboard upgrade is required, dashboard release v12.0.0
• CUMULUS-2915
  • API endpoint GET /executions/status/${executionArn} returns presignedS3Url and data
  • The user (dashboard) must read the s3SignedURL and data from the return
• CUMULUS-3070/3074
  • Updated granule PUT/POST endpoints to no longer respect message write
    constraints. Functionally this means that:
    • Granules with older createdAt values will replace newer ones, instead of
      ignoring the write request
    • Granules that attempt to set a non-complete state (e.g. 'queued' and
      'running') will now ignore execution state/state change and always write
    • Granules being set to non-complete state will update all values passed in,
      instead of being restricted to ['createdAt', 'updatedAt', 'timestamp', 'status', 'execution']

Note

• If you upgrade from cumulus version prior to v11.1.8, read release note in v11.1.8 about node14.19.1 upgrade.

Added

• CUMULUS-3070
  • Remove granules dynamoDb model logic that sets default publish value on record
    validation
  • Update API granule write logic to not set default publish value on record
    updates to avoid overwrite (PATCH behavior)
  • Update API granule write logic to publish to false on record
    creation if not specified
  • Update message granule write logic to set default publish value on record
    creation update.
  • Update granule write logic to set published to default value of false if
    null is explicitly set with intention to delete the value.
  • Removed dataType/version from api granule schema
  • Added @cumulus/api/endpoints/granules unit to cover duration overwrite
    logic for PUT/PATCH endpoint.
• CUMULUS-3098
  • Added task configuration setting named failTaskWhenFileBackupFail to the
    lzards-backup task. This setting is false by default, but when set to
    true, task will fail if one of the file backup request fails.

Changed

• Updated CI deploy process to utilize the distribution module in the published zip file which
  will be run against for the integration tests
• CUMULUS-2915
  • Updated API endpoint GET /executions/status/${executionArn} to return the
    pre-signed s3 URL in addition to execution status data
• CUMULUS-3045
  • Update GitHub FAQs:
    • Add new and refreshed content for previous sections
    • Add new dedicated Workflows section
• CUMULUS-3070
  • Updated API granule write logic to no longer require createdAt value in
    dynamo/API granule validation. Write-time createdAt defaults will be set in the case
    of new API granule writes without the value set, and createdAt will be
    overwritten if it already exists.
  • Refactored granule write logic to allow PATCH behavior on API granule update
    such that existing createdAt values will be retained in case of overwrite
    across all API granule writes.
  • Updated granule write code to validate written createdAt is synced between
    datastores in cases where granule.createdAt is not provided for a new
    granule.
  • Updated @cumulus/db/translate/granules.translateApiGranuleToPostgresGranuleWithoutNilsRemoved to validate incoming values to ensure values that can't be set to null are not
  • Updated @cumulus/db/translate/granules.translateApiGranuleToPostgresGranuleWithoutNilsRemoved to handle null values in incoming ApiGranule
  • Updated @cumulus/db/types/granules.PostgresGranule typings to allow for null values
  • Added ApiGranuleRecord to @cumulus/api/granule type to represent a written/retrieved from datastore API granule record.
  • Update API/Message write logic to handle nulls as deletion in granule PUT/message write logic
• CUMULUS-3075
  • Changed the API endpoint return value for a granule with no files. When a granule has no files, the return value beforehand for
    the translatePostgresGranuletoApiGranule, the function which does the translation of a Postgres granule to an API granule, was
    undefined, now changed to an empty array.
  • Existing behavior which relied on the pre-disposed undefined value was changed to instead accept the empty array.
  • Standardized tests in order to expect an empty array for a granule with no files files' object instead of undefined.
• CUMULUS-3077
  • Updated lambdas/data-migration2 granule and files migration to have a removeExcessFiles function like in write-granules that will remove file records no longer associated with a granule being migrated
• CUMULUS-3080
  • Changed the retention period in days from 14 to 30 for CloudWatch logs for NIST-5 compliance
• CUMULUS-3100
  • Updated POST granules endpoint to check if granuleId exists across all collections rather than a single collection.
  • Updated PUT granules endpoint to check if granuleId exists across a different collection and throw conflict error if so.
  • Updated logic for writing granules from a message to check if granuleId exists across a different collection and throw conflict error if so.

Fixed

• CUMULUS-3070
  • Fixed inaccurate typings for PostgresGranule in @cumulus/db/types/granule
  • Fixed inaccurate typings for @cumulus/api/granules.ApiGranule and updated to
    allow null
• CUMULUS-3104
  • Fixed TS compilation error on aws-client package caused by @aws-sdk/client-s3 3.202.0 upgrade
• CUMULUS-3116
  • Reverted the default ElasticSearch sorting behavior to the pre-13.3.0 configuration
  • Results from ElasticSearch are sorted by default by the timestamp field. This means that the order
    is not guaranteed if two or more records have identical timestamps as there is no secondary sort/tie-breaker.

v13.3.3-alpha.1

Fixed

• CUMULUS-3116
  • Reverted ElasticSearch sort behavior to pre-13.3.0. Introducing a fallback sort on
    _uid is thought to add additional latency to ElasticSearch requests
• CUMULUS-3104
  • Fixed TS compilation error on aws-client package caused by @aws-sdk/client-s3 3.202.0 upgrade

Changed

• CUMULUS-3104
  • Updated Dockerfile of async operation docker image to build from node:14.19.3-buster
  • Sets default async_operation_image version to 43.
  • Upgraded saml2-js 4.0.0, rewire to 6.0.0 to address security vulnerabilities
  • Fixed TS compilation error caused by @aws-sdk/client-s3 3.190->3.193 upgrade

v11.1.8

Breaking Changes

• CUMULUS-2903
  • The minimum supported version for all published Cumulus Core npm packages is now Node 14.19.1
  • Tasks using the cumuluss/cumulus-ecs-task Docker image must be updated to cumuluss/cumulus-ecs-task:1.8.0. This can be done by updating the image property of any tasks defined using the cumulus_ecs_service Terraform module.

Notable changes

• Published new tag 43 of cumuluss/async-operation to Docker Hub which was built with node:14.19.3-buster.

Changed

• CUMULUS-3104

  • Updated Dockerfile of async operation docker image to build from node:14.19.3-buster
  • Sets default async_operation_image version to 43.
  • Upgraded saml2-js 4.0.0, rewire to 6.0.0 to address security vulnerabilities
  • Fixed TS compilation error on aws-client package caused by @aws-sdk/client-s3 3.202.0 upgrade

• CUMULUS-3080

  • Changed the retention period in days from 14 to 30 for cloudwatch logs for NIST-5 compliance

v13.4.0

Notable changes

• Published new tag 43 of cumuluss/async-operation to Docker Hub which was built with node:14.19.3-buster.

Added

• CUMULUS-2998
  • Added Memory Size and Timeout terraform variable configuration for the following Cumulus tasks:
    • fake_processing_task_timeout and fake_processing_task_memory_size
    • files_to_granules_task_timeout and files_to_granule_task_memory_size
    • hello_world_task_timeout and hello_world_task_memory_size
    • sf_sqs_report_task_timeout and sf_sqs_report_task_memory_size
• CUMULUS-2986
  • Adds Terraform memory_size configurations to lambda functions with customizable timeouts enabled (the minimum default size has also been raised from 256 MB to 512 MB)
    allowed properties include:
    • add_missing_file_checksums_task_memory_size
    • discover_granules_task_memory_size
    • discover_pdrs_task_memory_size
    • hyrax_metadata_updates_task_memory_size
    • lzards_backup_task_memory_size
    • move_granules_task_memory_size
    • parse_pdr_task_memory_size
    • pdr_status_check_task_memory_size
    • post_to_cmr_task_memory_size
    • queue_granules_task_memory_size
    • queue_pdrs_task_memory_size
    • queue_workflow_task_memory_size
    • sync_granule_task_memory_size
    • update_cmr_access_constraints_task_memory_size
    • update_granules_cmr_task_memory_size
  • Initializes the lambda_memory_size(s) variable in the Terraform variable list
• CUMULUS-2631
  • Added 'Bearer token' support to s3credentials endpoint
• CUMULUS-2787
  • Added lzards-api-client package to Cumulus with submitQueryToLzards method
• CUMULUS-2944
  • Added configuration to increase the limit for body-parser's JSON and URL encoded parsers to allow for larger input payloads

Changed

• Updated example/cumulus-tf/variables.tf to have cmr_oauth_provider default to launchpad
• CUMULUS-2787
  • Updated lzards-backup-task to send Cumulus provider and granule createdAt values as metadata in LZARDS backup request to support querying LZARDS for reconciliation reports
• CUMULUS-2913
  • Changed process-dead-letter-archive lambda to put messages from S3 dead
    letter archive that fail to process to new S3 location.
• CUMULUS-2974
  • The DELETE /granules/<granuleId> endpoint now includes additional details about granule
    deletion, including collection, deleted granule ID, deleted files, and deletion time.
• CUMULUS-3027
  • Pinned typescript to ~4.7.x to address typing incompatibility issues
    discussed in knex/knex#5279
  • Update generate-ts-build-cache script to always install root project dependencies
• CUMULUS-3104
  • Updated Dockerfile of async operation docker image to build from node:14.19.3-buster
  • Sets default async_operation_image version to 43.
  • Upgraded saml2-js 4.0.0, rewire to 6.0.0 to address security vulnerabilities
  • Fixed TS compilation error caused by @aws-sdk/client-s3 3.190->3.193 upgrade

v13.3.2

Please note changes in 13.3.2 may not yet be released in future versions, as
this is a backport and patch release on the 13.3.x series of releases. Updates that
are included in the future will have a corresponding CHANGELOG entry in future
releases.

Fixed

• CUMULUS-3024
  • Update PUT /granules endpoint to operate consistently across datastores
    (PostgreSQL, ElasticSearch, DynamoDB). Previously it was possible, given a
    partial Granule payload to have different data in Dynamo/ElasticSearch and PostgreSQL
  • Given a partial Granule object, the /granules update endpoint now operates
    with behavior more consistent with a PATCH operation where fields not provided
    in the payload will not be updated in the datastores.
  • Granule translation (db/src/granules.ts) now supports removing null/undefined fields when converting from API to Postgres
    granule formats.
  • Update granule write logic: if a null files key is provided in an update payload (e.g. files: null),
    an error will be thrown. null files were not previously supported and would throw potentially unclear errors. This makes the error clearer and more explicit.
  • Update granule write logic: If an empty array is provided for the files key, all files will be removed in all datastores
• CUMULUS-2557
  • Updated @cumulus/aws-client/S3/moveObject to handle zero byte files (0 byte files).
• CUMULUS-2971
  • Updated @cumulus/aws-client/S3ObjectStore class to take string query parameters and
    its methods signGetObject and signHeadObject to take parameter presignOptions
• CUMULUS-3021
  • Updated @cumulus/api-client/collections and @cumulus/integration-tests/api to encode
    collection version in the URI path

v12.0.3

Please note changes in 12.0.3 may not yet be released in future versions, as
this is a backport and patch release on the 12.0.x series of releases. Updates that
are included in the future will have a corresponding CHANGELOG entry in future
releases.

Fixed

• CUMULUS-3024
  • Update PUT /granules endpoint to operate consistently across datastores
    (PostgreSQL, ElasticSearch, DynamoDB). Previously it was possible, given a
    partial Granule payload to have different data in Dynamo/ElasticSearch and PostgreSQL
  • Given a partial Granule object, the /granules update endpoint now operates
    with behavior more consistent with a PATCH operation where fields not provided
    in the payload will not be updated in the datastores.
  • Granule translation (db/src/granules.ts) now supports removing null/undefined fields when converting from API to Postgres
    granule formats.
  • Update granule write logic: if a null files key is provided in an update payload (e.g. files: null),
    an error will be thrown. null files were not previously supported and would throw potentially unclear errors. This makes the error clearer and more explicit.
  • Update granule write logic: If an empty array is provided for the files key, all files will be removed in all datastores
• CUMULUS-2971
  • Updated @cumulus/aws-client/S3ObjectStore class to take string query parameters and
    its methods signGetObject and signHeadObject to take parameter presignOptions
• CUMULUS-2557
  • Updated @cumulus/aws-client/S3/moveObject to handle zero byte files (0 byte files).
• CUMULUS-3021
  • Updated @cumulus/api-client/collections and @cumulus/integration-tests/api to encode
    collection version in the URI path

v11.1.7

Please note changes in 11.1.7 may not yet be released in future versions, as
this is a backport and patch release on the 11.1.x series of releases. Updates that
are included in the future will have a corresponding CHANGELOG entry in future
releases.

Fixed

• CUMULUS-3024
  • Update PUT /granules endpoint to operate consistently across datastores
    (PostgreSQL, ElasticSearch, DynamoDB). Previously it was possible, given a
    partial Granule payload to have different data in Dynamo/ElasticSearch and PostgreSQL
  • Given a partial Granule object, the /granules update endpoint now operates
    with behavior more consistent with a PATCH operation where fields not provided
    in the payload will not be updated in the datastores.
  • Granule translation (db/src/granules.ts) now supports removing null/undefined fields when converting from API to Postgres
    granule formats.
  • Update granule write logic: if a null files key is provided in an update payload (e.g. files: null),
    an error will be thrown. null files were not previously supported and would throw potentially unclear errors. This makes the error clearer and more explicit.
  • Update granule write logic: If an empty array is provided for the files key, all files will be removed in all datastores
• CUMULUS-2971
  • Updated @cumulus/aws-client/S3ObjectStore class to take string query parameters and
    its methods signGetObject and signHeadObject to take parameter presignOptions
• CUMULUS-2557
  • Updated @cumulus/aws-client/S3/moveObject to handle zero byte files (0 byte files).
• CUMULUS-3021
  • Updated @cumulus/api-client/collections and @cumulus/integration-tests/api to encode
    collection version in the URI path
• CUMULUS-3027
  • Pinned typescript to ~4.7.x to address typing incompatibility issues
    discussed in knex/knex#5279
  • Update generate-ts-build-cache script to always install root project dependencies

v13.3.0

Notable Changes

• CUMULUS-2930
  • The GET /granules endpoint has a new optional query parameter:
    searchContext, which is used to resume listing within the same search
    context. It is provided in every response from the endpoint as
    meta.searchContext. The searchContext value must be submitted with every
    consequent API call, and must be fetched from each new response to maintain
    the context.
  • Use of the searchContext query string parameter allows listing past 10,000 results.
  • Note that using the from query param in a request will cause the searchContext to
    be ignored and also make the query subject to the 10,000 results cap again.
  • Updated GET /granules endpoint to leverage ElasticSearch search-after API.
    The endpoint will only use search-after when the searchContext parameter
    is provided in a request.

v13.2.1

Notable changes

• CUMULUS-3019
  • Fix file write logic to delete files by granule_cumulus_id instead of
    cumulus_id. Previous logic removed files by matching file.cumulus_id
    to granule.cumulus_id.

v12.0.2

Notable changes

• CUMULUS-3019
  • Fix file write logic to delete files by granule_cumulus_id instead of
    cumulus_id. Previous logic removed files by matching file.cumulus_id
    to granule.cumulus_id.