@cumulus/common

@cumulus/common

Common libraries used in Cumulus.

Usage

  npm install @cumulus/common

About Cumulus

Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.

Cumulus Documentation

General Utilities

• @cumulus/common/aws - Utilities for working with AWS. For ease of setup, testing, and credential management, code should obtain AWS client objects from helpers in this module.
• @cumulus/common/concurrency - Utilities for writing concurrent code
• @cumulus/common/errors - Classes for thrown errors
• @cumulus/common/log - muting or potentially shipping logs to alternative locations
• @cumulus/common/string - Utilities for manipulating strings
• @cumulus/common/test-utils - Utilities for writing tests
• @cumulus/common/URLUtils - a collection of utilities for working with URLs
• @cumulus/common/util - Other misc general utilities

Contributing

To make a contribution, please see our contributing guidelines.

Changelog

[v6.0.0] 2021-02-16

MIGRATION NOTES

• CUMULUS-2255 - Cumulus has upgraded its supported version of Terraform from 0.12.12 to 0.13.6. Please see the instructions to upgrade your deployments.

• CUMULUS-2350

  • If the /s3credentialsREADME, does not appear to be working after deployment, manual redeployment of the API-gateway stage may be necessary to finish the deployment.

BREAKING CHANGES

• CUMULUS-2255 - Cumulus has upgraded its supported version of Terraform from 0.12.12 to 0.13.6.

Added

• CUMULUS-2291
  • Add provider filter to Granule Inventory Report
• CUMULUS-2300
  • Added childWorkflowMeta to queue-granules config. Object passed to this value will be merged into a child workflow message's meta object. For an example of how this can be used, see example/cumulus-tf/discover_granules_workflow.asl.json.
• CUMULUS-2350
  • Adds an unprotected endpoint, /s3credentialsREADME, to the s3-credentials-endpoint that displays information on how to use the /s3credentials endpoint
• CUMULUS-2368
  • Add QueueWorkflow task
• CUMULUS-2391
  • Add reportToEms to collections.files file schema
• CUMULUS-2395
  • Add Core module parameter ecs_custom_sg_ids to Cumulus module to allow for custom security group mappings
• CUMULUS-2402
  • Officially expose sftp() for use in @cumulus/sftp-client

Changed

• CUMULUS-2323

  • The sync granules task when used with the s3 provider now uses the source_bucket key in granule.files objects. If incoming payloads using this task have a source_bucket value for a file using the s3 provider, the task will attempt to sync from the bucket defined in the file's source_bucket key instead of the provider.
    • Updated S3ProviderClient.sync to allow for an optional bucket parameter in support of the changed behavior.
  • Removed addBucketToFile and related code from sync-granules task

• CUMULUS-2255

  • Updated Terraform deployment code syntax for compatibility with version 0.13.6

• CUMULUS-2321

  • Updated API endpoint GET /reconciliationReports/{name} to return the presigned s3 URL in addition to report data

Fixed

• Updated hyrax-metadata-updates task so the opendap url has Type 'USE SERVICE API'

• CUMULUS-2310

  • Use valid filename for reconciliation report

• CUMULUS-2351

  • Inventory report no longer includes the File/Granule relation object in the okCountByGranules key of a report. The information is only included when a 'Granule Not Found' report is run.

Removed

• CUMULUS-2364
  • Remove the internal Cumulus logging lambda (log2elasticsearch)