@cumulus/checksum
Advanced tools
The @cumulus/checksum library provides checksum functionality used by Cumulus
packages and tasks. Currently the supported input includes file streams, and
supported checksum algorithms include cksum and the algorithms available to
the crypto package, as documented
here.
const fs = require('fs');
const { generateChecksumFromStream } = require('@cumulus/checksum');
const stream = fs.createReadStream('myDataFile.hdf');
const myCksum = generateChecksumFromStream('cksum', stream);
Promise.<(number|string)>Promise.<boolean>Promise.<(number|string)>Create file checksum from readable stream
Kind: static method of checksum
Returns: Promise.<(number|string)> - the file checksum
| Param | Type | Description |
|---|---|---|
| algorithm | string | Checksum algorithm type |
| stream | stream.Readable | A readable file stream |
| [options] | Object | Checksum options, see crypto.createHash() |
Promise.<boolean>Validate expected checksum against calculated checksum
Kind: static method of checksum
Returns: Promise.<boolean> - whether expectedSum === calculatedSum
| Param | Type | Description |
|---|---|---|
| algorithm | string | Checksum algorithm |
| stream | stream.Readable | A readable file stream |
| expectedSum | number | string | expected checksum |
| [options] | Object | Checksum options |
Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.
Generated automatically using npm run build-docs
[v16.0.0] 2023-05-09
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):
files_granules_cumulus_id_index to the
files table may require manual steps depending on load.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
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.
bulk-operation Lambda should provide collectionId and granuleId e.g. { granuleId: xxx, collectionId: xxx }ReconciliationReportsTable from dbIndexer lambda@cumulus/api/ecs/async-operation/*asyncOperationsStart callsgetFilesExistingAtLocationfrom api granules model to api/lib, update granules put
endpoint to remove model referencesPOST endpointPUT endpointDELETE endpointPUT endpointrulesModel to rulesHelperapi/models/collections.js to api/lib/utils.jssfEventSqsToDbRecords lambdacreate in the db model for Rules
to return an array of objects containing all columns of the created record.rulesModel to rulesHelperDELETE endpointPUT endpoint@cumulus/apiexecuteMigrations lambdagranuleFilesCacheUpdater lambdadata-persistence module. This table and
all of its data will be removed on deployment.replaceGranule to @cumulus/api-client/granules to add usage of the
updated RESTful PUT logic@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]pg to v8.10.xxml2js to v0.5.0xml2js in saml2-js to
v0.5.0skip or error to stop retrying
after receiving a 404 Not Found Response Error from the cumulus-api.parallel package, as timeouts were not resulting in
integration test failure@cumulus/cmrjs/cmr-utils.getGranuleTemporalInfo to handle the error when the cmr file s3url is not availablesfEventSqsToDbRecords lambda to return partial batch failure,
and only reprocess messages when cumulus message can't be retrieved from the execution events.@cumulus/cumulus-message-adapter-js to 2.0.5 for all cumulus tasksFAQs
Cumulus checksum utilities
The npm package @cumulus/checksum receives a total of 165 weekly downloads. As such, @cumulus/checksum popularity was classified as not popular.
We found that @cumulus/checksum demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.