@cumulus/logger - npm Package Versions

[v16.0.0] 2023-05-09

Notable Changes

• The async_operation_image property of cumulus module should be updated to pull the ECR image for cumuluss/async-operation:46

MIGRATION notes

PI release version

When updating directly to v16 from prior releases older that V15, please make sure to read through all prior release notes.

Notable migration concerns since the last PI release version (11.1.x):

• [v14.1.0] - Postgres compatibility update to Aurora PostgreSQL 11.13.
• [v13.1.0] - Postgres update to add files_granules_cumulus_id_index to the files table may require manual steps depending on load.

RDS Phase 3 migration notes

This release includes updates that remove existing DynamoDB tables as part of release deployment process. This release cannot be properly rolled back in production as redeploying a prior version of Cumulus will not recover the associated Dynamo tables.

Please read the full change log for RDS Phase 3 and consult the RDS Phase 3 update documentation

API Endpoint Versioning

As part of the work on CUMULUS-3072, we have added a required header for the granule PUT/PATCH endpoints -- to ensure that older clients/utilities do not unexpectedly make destructive use of those endpoints, a validation check of a header value against supported versions has been implemented.

Moving forward, if a breaking change is made to an existing endpoint that requires user updates, as part of that update we will set the current version of the core API and require a header that confirms the client is compatible with the version required or greater.

In this instance, the granule PUT/PATCH endpoints will require a Cumulus-API-Version value of at least 2.

 curl --request PUT https://example.com/granules/granuleId.A19990103.006.1000\
 --header 'Cumulus-API-Version: 2'\
 --header 'Content-Type: application/json'\
 --header 'Authorization: Bearer ReplaceWithToken'\
 --data ...

Users/clients that do not make use of these endpoints will not be impacted.

RDS Phase 3

Breaking Changes

• CUMULUS-2688
  • Updated bulk operation logic to use collectionId in addition to granuleId to fetch granules.
  • Tasks using the bulk-operation Lambda should provide collectionId and granuleId e.g. { granuleId: xxx, collectionId: xxx }
• CUMULUS-2856
  • Update execution PUT endpoint to no longer respect message write constraints and update all values passed in

Changed

• CUMULUS-3282
  • Updated internal granule endpoint parameters from :granuleName to :granuleId for maintenance/consistency reasons
• CUMULUS-2312 - RDS Migration Epic Phase 3
  • CUMULUS-2645
    • Removed unused index functionality for all tables other than ReconciliationReportsTable from dbIndexer lambda
  • CUMULUS-2398
    • Remove all dynamoDB updates for @cumulus/api/ecs/async-operation/*
    • Updates all api endpoints with updated signature for asyncOperationsStart calls
    • Remove all dynamoDB models calls from async-operations api endpoints
  • CUMULUS-2801
    • Move getFilesExistingAtLocationfrom api granules model to api/lib, update granules put endpoint to remove model references
  • CUMULUS-2804
    • Updates api/lib/granule-delete.deleteGranuleAndFiles:
      • Updates dynamoGranule -> apiGranule in the signature and throughout the dependent code
      • Updates logic to make apiGranule optional, but pgGranule required, and all lookups use postgres instead of ES/implied apiGranule values
      • Updates logic to make pgGranule optional - in this case the logic removes the entry from ES only
    • Removes all dynamo model logic from api/endpoints/granules
    • Removes dynamo write logic from api/lib/writeRecords.*
    • Removes dynamo write logic from api/lib/ingest.*
    • Removes all granule model calls from api/lambdas/bulk-operations and any dependencies
    • Removes dynamo model calls from api/lib/granule-remove-from-cmr.unpublishGranule
    • Removes Post Deployment execution check from sf-event-sqs-to-db-records
    • Moves describeGranuleExecution from api granule model to api/lib/executions.js
  • CUMULUS-2806
    • Remove DynamoDB logic from executions POST endpoint
    • Remove DynamoDB logic from sf-event-sqs-to-db-records lambda execution writes.
    • Remove DynamoDB logic from executions PUT endpoint
  • CUMULUS-2808
    • Remove DynamoDB logic from executions DELETE endpoint
  • CUMULUS-2809
    • Remove DynamoDB logic from providers PUT endpoint
    • Updates DB models asyncOperation, provider and rule to return all fields on upsert.
  • CUMULUS-2810
    • Removes addition of DynamoDB record from API endpoint POST /provider/<name>
  • CUMULUS-2811
    • Removes deletion of DynamoDB record from API endpoint DELETE /provider/<name>
  • CUMULUS-2817
    • Removes deletion of DynamoDB record from API endpoint DELETE /collection/<name>/<version>
  • CUMULUS-2814
    • Move event resources deletion logic from rulesModel to rulesHelper
  • CUMULUS-2815
    • Move File Config and Core Config validation logic for Postgres Collections from api/models/collections.js to api/lib/utils.js
  • CUMULUS-2813
    • Removes creation and deletion of DynamoDB record from API endpoint POST /rules/
  • CUMULUS-2816
    • Removes addition of DynamoDB record from API endpoint POST /collections
  • CUMULUS-2797
    • Move rule helper functions to separate rulesHelpers file
  • CUMULUS-2821
    • Remove DynamoDB logic from sfEventSqsToDbRecords lambda
  • CUMULUS-2856
    • Update API/Message write logic to handle nulls as deletion in execution PUT/message write logic

Added

• CUMULUS-2312 - RDS Migration Epic Phase 3
  • CUMULUS-2813
    • Added function create in the db model for Rules to return an array of objects containing all columns of the created record.
  • CUMULUS-2812
    • Move event resources logic from rulesModel to rulesHelper
  • CUMULUS-2820
    • Remove deletion of DynamoDB record from API endpoint DELETE /pdr/<pdrName>
  • CUMULUS-2688
    • Add new endpoint to fetch granules by collectionId as well as granuleId: GET /collectionId/granuleId
    • Add new endpoints to update and delete granules by collectionId as well as granuleId

Removed

• CUMULUS-2994
  • Delete code/lambdas that publish DynamoDB stream events to SNS
• CUMULUS-3226
  • Removed Dynamo Async Operations table
• CUMULUS-3199
  • Removed DbIndexer lambda and all associated terraform resources
• CUMULUS-3009
  • Removed Dynamo PDRs table
• CUMULUS-3008
  • Removed DynamoDB Collections table
• CUMULUS-2815
  • Remove update of DynamoDB record from API endpoint PUT /collections/<name>/<version>
• CUMULUS-2814
  • Remove DynamoDB logic from rules DELETE endpoint
• CUMULUS-2812
  • Remove DynamoDB logic from rules PUT endpoint
• CUMULUS-2798
  • Removed AsyncOperations model
• CUMULUS-2797
• CUMULUS-2795
  • Removed API executions model
• CUMULUS-2796
  • Remove API pdrs model and all related test code
  • Remove API Rules model and all related test code
• CUMULUS-2794
  • Remove API Collections model and all related test code
  • Remove lambdas/postgres-migration-count-tool, api/endpoints/migrationCounts and api-client/migrationCounts
  • Remove lambdas/data-migration1 tool
  • Remove lambdas/data-migration2 and lambdas/postgres-migration-async-operation
• CUMULUS-2793
  • Removed Provider Dynamo model and related test code
• CUMULUS-2792
  • Remove API Granule model and all related test code
  • Remove granule-csv endpoint
• CUMULUS-2645
  • Removed dynamo structural migrations and related code from @cumulus/api
  • Removed executeMigrations lambda
  • Removed granuleFilesCacheUpdater lambda
  • Removed dynamo files table from data-persistence module. This table and all of its data will be removed on deployment.

Added

• CUMULUS-3072
  • Added replaceGranule to @cumulus/api-client/granules to add usage of the updated RESTful PUT logic
• CUMULUS-3121
  • Added a map of variables for the cloud_watch_log retention_in_days for the various cloudwatch_log_groups, as opposed to keeping them hardcoded at 30 days. Can be configured by adding the <module>_<cloudwatch_log_group_name>_log_retention value in days to the cloudwatch_log_retention_groups map variable
• CUMULUS-3201
  • Added support for sha512 as checksumType for LZARDs backup task.

Changed

• CUMULUS-3315
  • Updated @cumulus/api-client/granules.bulkOperation to remove ids parameter in favor of granules parameter, in the form of a @cumulus/types/ApiGranule that requires the following keys: [granuleId, collectionId]
• CUMULUS-3307
  • Pinned cumulus dependency on pg to v8.10.x
• CUMULUS-3279
  • Updated core dependencies on xml2js to v0.5.0
  • Forcibly updated downstream dependency for xml2js in saml2-js to v0.5.0
  • Added audit-ci CVE override until July 1 to allow for Core package releases
• CUMULUS-3106
  • Updated localstack version to 1.4.0 and removed 'skip' from all skipped tests
• CUMULUS-3115
  • Fixed DiscoverGranules' workflow's duplicateHandling when set to skip or error to stop retrying after receiving a 404 Not Found Response Error from the cumulus-api.
• CUMULUS-3165
  • Update example/cumulus-tf/orca.tf to use orca v6.0.3

Fixed

• CUMULUS-3315
  • Update CI scripts to use shell logic/GNU timeout to bound test timeouts instead of NPM parallel package, as timeouts were not resulting in integration test failure
• CUMULUS-3223
  • Update @cumulus/cmrjs/cmr-utils.getGranuleTemporalInfo to handle the error when the cmr file s3url is not available
  • Update sfEventSqsToDbRecords lambda to return partial batch failure, and only reprocess messages when cumulus message can't be retrieved from the execution events.
  • Update @cumulus/cumulus-message-adapter-js to 2.0.5 for all cumulus tasks

[v15.0.4] 2023-06-23

Changed

• CUMULUS-3307
  • Pinned cumulus dependency on pg to v8.10.x

Fixed

• CUMULUS-3115
  • Fixed DiscoverGranules' workflow's duplicateHandling when set to skip or error to stop retrying after receiving a 404 Not Found Response Error from the cumulus-api.
• CUMULUS-3315
  • Update CI scripts to use shell logic/GNU timeout to bound test timeouts instead of NPM parallel package, as timeouts were not resulting in integration test failure
• CUMULUS-3223
  • Update @cumulus/cmrjs/cmr-utils.getGranuleTemporalInfo to handle the error when the cmr file s3url is not available
  • Update sfEventSqsToDbRecords lambda to return partial batch failure, and only reprocess messages when cumulus message can't be retrieved from the execution events.
  • Update @cumulus/cumulus-message-adapter-js to 2.0.5 for all cumulus tasks

[v15.0.3] 2023-04-28

Fixed

• CUMULUS-3243
  • Updated granule delete logic to delete granule which is not in DynamoDB
  • Updated granule unpublish logic to handle granule which is not in DynamoDB and/or CMR

[v15.0.2] 2023-04-25

Fixed

• CUMULUS-3120
  • Fixed a bug by adding in default_log_retention_periods and cloudwatch_log_retention_periods to Cumulus modules so they can be used during deployment for configuring cloudwatch retention periods, for more information check here: retention document
  • Updated cloudwatch retention documentation to reflect the bugfix changes

[v15.0.1] 2023-04-20

Changed

• CUMULUS-3279
  • Updated core dependencies on xml2js to v0.5.0
  • Forcibly updated downstream dependency for xml2js in saml2-js to v0.5.0
  • Added audit-ci CVE override until July 1 to allow for Core package releases

Fixed

• CUMULUS-3285
  • Updated api/lib/distribution.js isAuthBearTokenRequest to handle non-Bearer authorization header

[v15.0.0] 2023-03-10

Breaking Changes

• CUMULUS-3147
  • The minimum supported version for all published Cumulus Core npm packages is now Node 16.19.0
  • Tasks using the cumuluss/cumulus-ecs-task Docker image must be updated to cumuluss/cumulus-ecs-task:1.9.0. which is built with node:16.19.0-alpine. This can be done by updating the image property of any tasks defined using the cumulus_ecs_service Terraform module.
  • Updated Dockerfile of async operation docker image to build from node:16.19.0-buster
  • Published new tag 44 of cumuluss/async-operation to Docker Hub.
  • The async_operation_image property of cumulus module must be updated to pull the ECR image for cumuluss/async-operation:44.

Changed

• CUMULUS-2997
  • Migrate Cumulus Docs to Docusaurus v2 and DocSearch v3.
• CUMULUS-3044
  • Deployment section:
    • Consolidate and migrate Cumulus deployment (public facing) content from wiki to Cumulus Docs in GitHub.
    • Update links to make sure that the user can maintain flow between the wiki and GitHub deployment documentation.
    • Organize and update sidebar to include categories for similar deployment topics.
• CUMULUS-3147
  • Set example/cumulus-tf default async_operation_image_version to 44.
  • Set example/cumulus-tf default ecs_task_image_version to 1.9.0.
• CUMULUS-3166
  • Updated example/cumulus-tf/thin_egress_app.tf to use tea 1.3.2

Fixed

• CUMULUS-3187
  • Restructured Earthdata Login class to be individual methods as opposed to a Class Object
  • Removed typescript no-checks and reformatted EarthdataLogin code to be more type friendly

[v14.1.0] 2023-02-27

MIGRATION notes

PostgreSQL compatibility update

From this release forward Core will be tested against PostgreSQL 11 Existing release compatibility testing was done for release 11.1.8/14.0.0+. Users should migrate their datastores to Aurora PostgreSQL 11.13+ compatible data stores as soon as possible.

Users utilizing the cumulus-rds-tf module will have upgraded/had their database clusters forcibly upgraded at the next maintenance window after 31 Jan 2023. Our guidance to mitigate this issue is to do a manual (outside of terraform) upgrade. This will result in the cluster being upgraded with a manually set parameter group not managed by terraform.

If you manually upgraded and the cluster is now on version 11.13, to continue using the cumulus-rds-tf module once upgraded update following module configuration values if set, or allow their defaults to be utilized:

parameter_group_family = "aurora-postgresql11"
engine_version = 11.13

When you apply this update, the original PostgreSQL v10 parameter group will be removed, and recreated using PG11 defaults/configured terraform values and update the database cluster to use the new configuration.

Added

• CUMULUS-3193
  • Add a Python version file
• CUMULUS-3121
  • Added a map of variables in terraform for custom configuration of cloudwatch_log_groups' retention periods. Please refer to the [Cloudwatch-Retention] (https://nasa.github.io/cumulus/docs/configuration/cloudwatch-retention) section of the Cumulus documentation in order for more detailed information and an example into how to do this.
• CUMULUS-3071
  • Added 'PATCH' granules endpoint as an exact duplicate of the existing PUT endpoint. In future releases the PUT endpoint will be replaced with valid PUT logic behavior (complete overwrite) in a future release. The existing PUT implementation is deprecated and users should move all existing usage of PUT to PATCH before upgrading to a release with CUMULUS-3072.

Fixed

• CUMULUS-3033

  • Fixed granuleEsQuery to properly terminate if body.hit.total.value is 0.

• The getLambdaAliases function has been removed from the @cumulus/integration-tests package

• The getLambdaVersions function has been removed from the @cumulus/integration-tests package

• CUMULUS-3117

  • Update @cumulus/es-client/indexer.js to properly handle framework write constraints for queued granules. Queued writes will now be properly dropped from elasticsearch writes along with the primary datastore(s) when write constraints apply

• CUMULUS-3134

  • Get tests working on M1 Macs

• CUMULUS-3148:

  • Updates cumulus-rds-tf to use defaults for PostgreSQL 11.13
  • Update IngestGranuleSuccessSpec as test was dependant on file ordering and PostgreSQL 11 upgrade exposed dependency on database results in the API return
  • Update unit test container to utilize PostgreSQL 11.13 container

• CUMULUS-3149

  • Updates the api /granules/bulkDelete endpoint to take the following configuration keys for the bulkDelete:
    • concurrency - Number of concurrent bulk deletions to process at a time. Defaults to 10, increasing this value may improve throughput at the cost of additional database/CMR/etc load.
    • maxDbConnections - Defaults to concurrency, and generally should not be changed unless troubleshooting performance concerns.
  • Updates all bulk api endpoints to add knexDebug boolean query parameter to allow for debugging of database connection issues in the future. Defaults to false.
  • Fixed logic defect in bulk deletion logic where an information query was nested in a transaction call, resulting in transactions holding knex connection pool connections in a blocking way that would not resolve, resulting in deletion failures.

• CUMULUS-3142

  • Fix issue from CUMULUS-3070 where undefined values for status results in unexpected insertion failure on PATCH.

• CUMULUS-3181

  • Fixed sqsMessageRemover lambda to correctly retrieve ENABLED sqs rules.

• CUMULUS-3189

  • Upgraded cumulus-process and cumulus-message-adapter-python versions to support pip 23.0

• CUMULUS-3196

  • Moved createServer initialization outside the s3-credentials-endpoint lambda handler to reduce file descriptor usage

• README shell snippets better support copying

• CUMULUS-3111

  • Fix issue where if granule update dropped due to write constraints for writeGranuleFromMessage, still possible for granule files to be written
  • Fix issue where if granule update is limited to status and timestamp values due to write constraints for writeGranuleFromMessage, Dynamo or ES granules could be out of sync with PG

Breaking Changes

• CUMULUS-3072
  • Removed original PUT granule endpoint logic (in favor of utilizing new PATCH endpoint introduced in CUMULUS-3071)
  • Updated PUT granule endpoint to expected RESTful behavior:
    • PUT will now overwrite all non-provided fields as either non-defined or defaults, removing existing related database records (e.g. files, granule-execution linkages ) as appropriate.
    • PUT will continue to overwrite fields that are provided in the payload, excepting collectionId and granuleId which cannot be modified.
    • PUT will create a new granule record if one does not already exist
    • Like PATCH, the execution field is additive only - executions, once associated with a granule record cannot be unassociated via the granule endpoint.
  • /granule PUT and PATCH endpoints now require a header with values { version: 2 }
  • PUT endpoint will now only support /:collectionId/:granuleId formatted queries
  • `@cumulus/api-client.replaceGranule now utilizes body.collectionId to utilize the correct API PUT endpoint
  • Cumulus API version updated to 2

Changed

• Snyk Security
  • Upgraded jsonwebtoken from 8.5.1 to 9.0.0
  • CUMULUS-3160: Upgrade knex from 0.95.15 to 2.4.1
  • Upgraded got from 11.8.3 to ^11.8.5
• Dependabot Security
  • Upgraded the python package dependencies of the example lambdas
• CUMULUS-3043
  • Organize & link Getting Started public docs for better user guidance
  • Update Getting Started sections with current content
• CUMULUS-3046
  • Update 'Deployment' public docs
  • Apply grammar, link fixes, and continuity/taxonomy standards
• CUMULUS-3071
  • Updated @cumulus/api-client packages to use PATCH protocol for existing granule PUT calls, this change should not require user updates for api-client users.
    • @cumulus/api-client/granules.updateGranule
    • @cumulus/api-client/granules.moveGranule
    • @cumulus/api-client/granules.updateGranule
    • @cumulus/api-client/granules.reingestGranule
    • @cumulus/api-client/granules.removeFromCMR
    • @cumulus/api-client/granules.applyWorkflow
• CUMULUS-3097
  • Changed @cumulus/cmr-client package's token from Echo-Token to Earthdata Login (EDL) token in updateToken method
  • Updated CMR header and token tests to reflect the Earthdata Login changes
• CUMULUS-3144
  • Increased the memory of API lambda to 1280MB
• CUMULUS-3140
  • Update release note to include cumulus-api release
• CUMULUS-3193
  • Update eslint config to better support typing
• Improve linting of TS files

Removed

• CUMULUS-2798
  • Removed AsyncOperations model

Removed

• CUMULUS-3009
  • Removed Dynamo PDRs table