@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

[v1.24.0] 2020-06-03

BREAKING CHANGES

• CUMULUS-1969

  • The DiscoverPdrs task now expects provider_path to be provided at event.config.provider_path, not event.config.collection.provider_path
  • event.config.provider_path is now a required parameter of the DiscoverPdrs task
  • event.config.collection is no longer a parameter to the DiscoverPdrs task
  • Collections no longer support the provider_path property. The tasks that relied on that property are now referencing config.meta.provider_path. Workflows should be updated accordingly.

• CUMULUS-1997

  • @cumulus/cmr-client/CMRSearchConceptQueue parameters have been changed to take a cmrSettings object containing clientId, provider, and auth information. This can be generated using @cumulus/cmrjs/cmr-utils/getCmrSettings. The cmrEnvironment variable has been removed.

Added

• CUMULUS-1800
  • Added task configuration setting named syncChecksumFiles to the SyncGranule task. This setting is false by default, but when set to true, all checksum files associated with data files that are downloaded will be downloaded as well.
• CUMULUS-1952
  • Updated HTTP(S) provider client to accept username/password for Basic authorization. This change adds support for Basic Authorization such as Earthdata login redirects to ingest (i.e. as implemented in SyncGranule), but not to discovery (i.e. as implemented in DiscoverGranules). Discovery still expects the provider's file system to be publicly accessible, but not the individual files and their contents.
  • NOTE: Using this in combination with the HTTP protocol may expose usernames and passwords to intermediary network entities. HTTPS is highly recommended.
• CUMULUS-1997
  • Added optional launchpad configuration to @cumulus/hyrax-metadata-updates task config schema.

Fixed

• CUMULUS-1997
  • Updated all CMR operations to use configured authentication scheme
• CUMULUS-2010
  • Updated @cumulus/api/launchpadSaml to support multiple userGroup attributes from the SAML response