@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 - Implementations of distributed concurrency primitives (mutex, semaphore) using DynamoDB
• @cumulus/common/errors - Classes for thrown errors
• @cumulus/common/local-helpers - Provides methods for setting up message payloads for use in development / local testing
• @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

[v1.17.0] - 2019-12-31

BREAKING CHANGES

• CUMULUS-1498
  • The @cumulus/cmrjs.publish2CMR function expects that the value of its creds.password parameter is a plaintext password.
  • Rather than using an encrypted password from the cmr_password environment variable, the @cumulus/cmrjs.updateCMRMetadata function now looks for an environment variable called cmr_password_secret_name and fetches the CMR password from that secret in AWS Secrets Manager.
  • The @cumulus/post-to-cmr task now expects a config.cmr.passwordSecretName value, rather than config.cmr.password. The CMR password will be fetched from that secret in AWS Secrets Manager.

Added

• CUMULUS-630

  • Added support for replaying Kinesis records on a stream into the Cumulus Kinesis workflow triggering mechanism: either all the records, or some time slice delimited by start and end timestamps.
  • Added /replays endpoint to the operator API for triggering replays.
  • Added Replay Kinesis Messages documentation to Operator Docs.
  • Added manualConsumer lambda function to consume a Kinesis stream. Used by the replay AsyncOperation.

• CUMULUS-1687

  • Added new API endpoint for listing async operations at /asyncOperations
  • All asyncOperations now include the fields description and operationType. operationType can be one of the following. [Bulk Delete, Bulk Granules, ES Index, Kinesis Replay]

Changed

• CUMULUS-1626

  • Updates Cumulus to use node10/CMA 1.1.2 for all of its internal lambdas in prep for AWS node 8 EOL

• CUMULUS-1498

  • Remove the DynamoDB Users table. The list of OAuth users who are allowed to use the API is now stored in S3.
  • The CMR password and Launchpad passphrase are now stored in Secrets Manager