@cumulus/es-client 10.1.0 → 10.1.2-alpha.0

package/indexer.js

@@ -1,5 +1,5 @@
 /* functions for transforming and indexing Cumulus Payloads
- * in ElasticSearch. These functions are specifically designed
+ * in Elasticsearch. These functions are specifically designed
  * to transform data for use in cumulus api
  *
  * The module accepts the following kinds of workflows (state machines):
@@ -46,9 +46,9 @@ async function createIndex(esClient, indexName) {
 }
 
 /**
- * Indexes a given record to the specified ElasticSearch index and type
+ * Indexes a given record to the specified Elasticsearch index and type
  *
- * @param  {Object} esClient - ElasticSearch Connection object
+ * @param  {Object} esClient - Elasticsearch Connection object
  * @param  {string} id       - the record id
  * @param  {Object} doc      - the record
  * @param  {string} index    - Elasticsearch index alias
@@ -84,11 +84,99 @@ async function genericRecordUpdate(esClient, id, doc, index, type, parent) {
   return indexResponse.body;
 }
 
+/**
+ * Updates a given record for the Elasticsearch index and type
+ *
+ * @param  {Object} esClient - Elasticsearch Connection object
+ * @param  {string} id       - the record id
+ * @param  {Object} doc      - the record
+ * @param  {string} index    - Elasticsearch index alias
+ * @param  {string} type     - Elasticsearch type
+ * @returns {Promise} Elasticsearch response
+ */
+async function updateExistingRecord(esClient, id, doc, index, type) {
+  return await esClient.update({
+    index,
+    type,
+    id,
+    body: {
+      doc: {
+        ...doc,
+        timestamp: Date.now(),
+      },
+    },
+    refresh: inTestMode(),
+  });
+}
+
+/**
+ * Updates an asyncOperation record in Elasticsearch
+ *
+ * @param  {Object} esClient - Elasticsearch Connection object
+ * @param  {Object} id - Record ID
+ * @param  {Object} updates - Document of updates to apply
+ * @param  {string} index - Elasticsearch index alias (default defined in search.js)
+ * @param  {string} type - Elasticsearch type (default: asyncOperation)
+ * @returns {Promise} elasticsearch update response
+ */
+function updateAsyncOperation(esClient, id, updates, index = defaultIndexAlias, type = 'asyncOperation') {
+  return updateExistingRecord(esClient, id, updates, index, type);
+}
+
+/**
+ * Upsert an execution record in Elasticsearch
+ *
+ * @param {Object} params
+ * @param {Object} params.esClient - Elasticsearch Connection object
+ * @param {Object} params.updates - Document of updates to apply
+ * @param {string} params.index - Elasticsearch index alias (default defined in search.js)
+ * @param {string} params.type - Elasticsearch type (default: execution)
+ * @param {string} [params.refresh] - whether to refresh the index on update or not
+ * @returns {Promise} elasticsearch update response
+ */
+async function upsertExecution({
+  esClient,
+  updates,
+  index = defaultIndexAlias,
+  type = 'execution',
+  refresh,
+}) {
+  const upsertDoc = {
+    ...updates,
+    timestamp: Date.now(),
+  };
+  return await esClient.update({
+    index,
+    type,
+    id: upsertDoc.arn,
+    body: {
+      script: {
+        lang: 'painless',
+        inline: `
+          if (params.doc.status == "running") {
+            ctx._source.updatedAt = params.doc.updatedAt;
+            ctx._source.timestamp = params.doc.timestamp;
+            ctx._source.originalPayload = params.doc.originalPayload;
+          } else {
+            ctx._source.putAll(params.doc)
+          }
+        `,
+        params: {
+          doc: upsertDoc,
+        },
+      },
+      upsert: upsertDoc,
+    },
+    refresh: refresh !== undefined ? refresh : inTestMode(),
+    retry_on_conflict: 3,
+  });
+}
+
 /**
  * Indexes a step function message to Elastic Search. The message must
  * comply with the cumulus message protocol
  *
- * @param  {Object} esClient - ElasticSearch Connection object
+ * @param  {Object} esClient - Elasticsearch Connection object
  * @param  {Object} payload  - Cumulus Step Function message
  * @param  {string} index    - Elasticsearch index alias (default defined in search.js)
  * @param  {string} type     - Elasticsearch type (default: execution)
@@ -99,9 +187,9 @@ function indexExecution(esClient, payload, index = defaultIndexAlias, type = 'ex
 }
 
 /**
- * Indexes the asyncOperation type on ElasticSearch
+ * Indexes the asyncOperation type on Elasticsearch
  *
- * @param  {Object} esClient - ElasticSearch Connection object
+ * @param  {Object} esClient - Elasticsearch Connection object
  * @param  {Object} payload  - Cumulus Step Function message
  * @param  {string} index    - Elasticsearch index alias (default defined in search.js)
  * @param  {string} type     - Elasticsearch type (default: asyncOperation)
@@ -112,23 +200,23 @@ function indexAsyncOperation(esClient, payload, index = defaultIndexAlias, type
 }
 
 /**
- * Indexes the collection on ElasticSearch
+ * Indexes the collection on Elasticsearch
  *
- * @param  {Object} esClient - ElasticSearch Connection object
- * @param  {Object} meta     - the collection record
- * @param  {string} index    - Elasticsearch index alias (default defined in search.js)
- * @param  {string} type     - Elasticsearch type (default: collection)
+ * @param  {Object} esClient - Elasticsearch Connection object
+ * @param  {Object} collection - the collection record
+ * @param  {string} index - Elasticsearch index alias (default defined in search.js)
+ * @param  {string} type - Elasticsearch type (default: collection)
  * @returns {Promise} Elasticsearch response
  */
-function indexCollection(esClient, meta, index = defaultIndexAlias, type = 'collection') {
-  const collectionId = constructCollectionId(meta.name, meta.version);
-  return genericRecordUpdate(esClient, collectionId, meta, index, type);
+function indexCollection(esClient, collection, index = defaultIndexAlias, type = 'collection') {
+  const collectionId = constructCollectionId(collection.name, collection.version);
+  return genericRecordUpdate(esClient, collectionId, collection, index, type);
 }
 
 /**
- * Indexes the provider type on ElasticSearch
+ * Indexes the provider type on Elasticsearch
  *
- * @param  {Object} esClient - ElasticSearch Connection object
+ * @param  {Object} esClient - Elasticsearch Connection object
  * @param  {Object} payload  - the provider record
  * @param  {string} index    - Elasticsearch index alias (default defined in search.js)
  * @param  {string} type     - Elasticsearch type (default: provider)
@@ -139,9 +227,9 @@ function indexProvider(esClient, payload, index = defaultIndexAlias, type = 'pro
 }
 
 /**
- * Indexes the reconciliationReport type on ElasticSearch
+ * Indexes the reconciliationReport type on Elasticsearch
  *
- * @param  {Object} esClient - ElasticSearch Connection object
+ * @param  {Object} esClient - Elasticsearch Connection object
  * @param  {Object} payload  - the ReconciliationReport record
  * @param  {string} index    - Elasticsearch index alias (default defined in search.js)
  * @param  {string} type     - Elasticsearch type (default: reconciliationReport)
@@ -152,9 +240,9 @@ function indexReconciliationReport(esClient, payload, index = defaultIndexAlias,
 }
 
 /**
- * Indexes the rule type on ElasticSearch
+ * Indexes the rule type on Elasticsearch
  *
- * @param  {Object} esClient - ElasticSearch Connection object
+ * @param  {Object} esClient - Elasticsearch Connection object
  * @param  {Object} payload  - the Rule record
  * @param  {string} index    - Elasticsearch index alias (default defined in search.js)
  * @param  {string} type     - Elasticsearch type (default: rule)
@@ -166,9 +254,9 @@ function indexRule(esClient, payload, index = defaultIndexAlias, type = 'rule')
 }
 
 /**
- * Indexes the granule type on ElasticSearch
+ * Indexes the granule type on Elasticsearch
  *
- * @param  {Object} esClient - ElasticSearch Connection object
+ * @param  {Object} esClient - Elasticsearch Connection object
  * @param  {Object} payload  - Cumulus Step Function message
  * @param  {string} index    - Elasticsearch index alias (default defined in search.js)
  * @param  {string} type     - Elasticsearch type (default: granule)
@@ -197,9 +285,67 @@ async function indexGranule(esClient, payload, index = defaultIndexAlias, type =
 }
 
 /**
- * Indexes the pdr type on ElasticSearch
+ * Upserts a granule in Elasticsearch
+ *
+ * @param {Object} params
+ * @param {Object} params.esClient - Elasticsearch Connection object
+ * @param {Object} params.updates  - Updates to make
+ * @param {string} params.index    - Elasticsearch index alias (default defined in search.js)
+ * @param {string} params.type     - Elasticsearch type (default: granule)
+ * @param {string} [params.refresh] - whether to refresh the index on update or not
+ * @returns {Promise} Elasticsearch response
+ */
+async function upsertGranule({
+  esClient,
+  updates,
+  index = defaultIndexAlias,
+  type = 'granule',
+  refresh,
+}) {
+  // If the granule exists in 'deletedgranule', delete it first before inserting the granule
+  // into ES.  Ignore 404 error, so the deletion still succeeds if the record doesn't exist.
+  const delGranParams = {
+    index,
+    type: 'deletedgranule',
+    id: updates.granuleId,
+    parent: updates.collectionId,
+    refresh: inTestMode(),
+  };
+  await esClient.delete(delGranParams, { ignore: [404] });
+
+  const upsertDoc = updates;
+
+  return await esClient.update({
+    index,
+    type,
+    id: updates.granuleId,
+    parent: updates.collectionId,
+    body: {
+      script: {
+        lang: 'painless',
+        inline: `
+          if ((ctx._source.createdAt === null || params.doc.createdAt >= ctx._source.createdAt)
+            && (params.doc.status != 'running' || (params.doc.status == 'running' && params.doc.execution != ctx._source.execution))) {
+            ctx._source.putAll(params.doc);
+          } else {
+            ctx.op = 'none';
+          }
+        `,
+        params: {
+          doc: upsertDoc,
+        },
+      },
+      upsert: upsertDoc,
+    },
+    refresh: refresh !== undefined ? refresh : inTestMode(),
+    retry_on_conflict: 3,
+  });
+}
+
+/**
+ * Indexes the pdr type on Elasticsearch
  *
- * @param  {Object} esClient - ElasticSearch Connection object
+ * @param  {Object} esClient - Elasticsearch Connection object
  * @param  {Object} payload  - Cumulus Step Function message
  * @param  {string} index    - Elasticsearch index alias (default defined in search.js)
  * @param  {string} type     - Elasticsearch type (default: pdr)
@@ -216,10 +362,58 @@ async function indexPdr(esClient, payload, index = defaultIndexAlias, type = 'pd
 }
 
 /**
- * delete a record from ElasticSearch
+ * Upsert a PDR record in Elasticsearch
+ *
+ * @param {Object} params
+ * @param {Object} params.esClient - Elasticsearch Connection object
+ * @param {Object} params.updates - Document to upsert
+ * @param {string} params.index - Elasticsearch index alias (default defined in search.js)
+ * @param {string} params.type - Elasticsearch type (default: execution)
+ * @param {string} [params.refresh] - whether to refresh the index on update or not
+ * @returns {Promise} elasticsearch update response
+ */
+async function upsertPdr({
+  esClient,
+  updates,
+  index = defaultIndexAlias,
+  type = 'pdr',
+  refresh,
+}) {
+  const upsertDoc = {
+    ...updates,
+    timestamp: Date.now(),
+  };
+  return await esClient.update({
+    index,
+    type,
+    id: upsertDoc.pdrName,
+    body: {
+      script: {
+        lang: 'painless',
+        inline: `
+          if ((ctx._source.createdAt === null || params.doc.createdAt >= ctx._source.createdAt)
+            && (params.doc.execution != ctx._source.execution || params.doc.progress > ctx._source.progress)) {
+            ctx._source.putAll(params.doc);
+          } else {
+            ctx.op = 'none';
+          }
+        `,
+        params: {
+          doc: upsertDoc,
+        },
+      },
+      upsert: upsertDoc,
+    },
+    refresh: refresh !== undefined ? refresh : inTestMode(),
+    retry_on_conflict: 3,
+  });
+}
+
+/**
+ * delete a record from Elasticsearch
  *
  * @param  {Object} params
- * @param  {Object} params.esClient - ElasticSearch Connection object
+ * @param  {Object} params.esClient - Elasticsearch Connection object
  * @param  {string} params.id       - id of the Elasticsearch record
  * @param  {string} params.type     - Elasticsearch type (default: execution)
  * @param  {strint} params.parent   - id of the parent (optional)
@@ -248,50 +442,271 @@ async function deleteRecord({
   if (ignore) options = { ignore };
 
   const actualEsClient = esClient || (await Search.es());
-
-  const getResponse = await actualEsClient.get(params, options);
   const deleteResponse = await actualEsClient.delete(params, options);
-
-  if (type === 'granule' && getResponse.body.found) {
-    const doc = getResponse.body._source;
-    doc.timestamp = Date.now();
-    doc.deletedAt = Date.now();
-
-    // When a 'granule' record is deleted, the record is added to 'deletedgranule' type
-    await genericRecordUpdate(
-      actualEsClient,
-      doc.granuleId,
-      doc,
-      index,
-      'deletedgranule',
-      parent
-    );
-  }
   return deleteResponse.body;
 }
 
 /**
- * Index a record to local Elasticsearch. Used when running API locally.
+ * Deletes the collection in Elasticsearch
+ *
+ * @param  {Object} params
+ * @param  {Object} params.esClient - Elasticsearch Connection object
+ * @param  {string} params.collectionId - the collection ID
+ * @param  {string[]} [params.ignore] - Array of response codes to ignore
+ * @param  {string} params.index - Elasticsearch index alias (default defined in search.js)
+ * @param  {string} params.type - Elasticsearch type (default: collection)
+ * @returns {Promise} Elasticsearch response
+ */
+function deleteCollection({
+  esClient,
+  collectionId,
+  ignore,
+  index = defaultIndexAlias,
+  type = 'collection',
+}) {
+  return deleteRecord({
+    esClient,
+    id: collectionId,
+    index,
+    type,
+    ignore,
+  });
+}
+
+/**
+ * Deletes the provider in Elasticsearch
  *
- * @param {Object} record - Record object
- * @param {function} doIndex - Function to do indexing operation
- * @returns {Promise} - Promise of indexing operation
+ * @param  {Object} params
+ * @param  {Object} params.esClient - Elasticsearch Connection object
+ * @param  {string} params.id - the provider ID
+ * @param  {string[]} [params.ignore] - Array of response codes to ignore
+ * @param  {string} params.index - Elasticsearch index alias (default defined in search.js)
+ * @param  {string} params.type - Elasticsearch type (default: provider)
+ * @returns {Promise} Elasticsearch response
  */
-async function addToLocalES(record, doIndex) {
-  const esClient = await Search.es(process.env.ES_HOST);
-  return doIndex(esClient, record, process.env.ES_INDEX);
+function deleteProvider({
+  esClient,
+  id,
+  ignore,
+  index = defaultIndexAlias,
+  type = 'provider',
+}) {
+  return deleteRecord({
+    esClient,
+    id,
+    index,
+    type,
+    ignore,
+  });
+}
+
+/**
+ * Deletes the rule in Elasticsearch
+ *
+ * @param  {Object} params
+ * @param  {Object} params.esClient - Elasticsearch Connection object
+ * @param  {string} params.name - the rule name
+ * @param  {string[]} [params.ignore] - Array of response codes to ignore
+ * @param  {string} params.index - Elasticsearch index alias (default defined in search.js)
+ * @param  {string} params.type - Elasticsearch type (default: rule)
+ * @returns {Promise} Elasticsearch response
+ */
+function deleteRule({
+  esClient,
+  name,
+  ignore,
+  index = defaultIndexAlias,
+  type = 'rule',
+}) {
+  return deleteRecord({
+    esClient,
+    id: name,
+    index,
+    type,
+    ignore,
+  });
+}
+
+/**
+ * Deletes the PDR in Elasticsearch
+ *
+ * @param  {Object} params
+ * @param  {Object} params.esClient - Elasticsearch Connection object
+ * @param  {string} params.name - the PDR name
+ * @param  {string[]} [params.ignore] - Array of response codes to ignore
+ * @param  {string} params.index - Elasticsearch index alias (default defined in search.js)
+ * @param  {string} params.type - Elasticsearch type (default: PDR)
+ * @returns {Promise} Elasticsearch response
+ */
+function deletePdr({
+  esClient,
+  name,
+  ignore,
+  index = defaultIndexAlias,
+  type = 'pdr',
+}) {
+  return deleteRecord({
+    esClient,
+    id: name,
+    index,
+    type,
+    ignore,
+  });
+}
+
+/**
+ * Deletes the execution in Elasticsearch
+ *
+ * @param  {Object} params
+ * @param  {Object} params.esClient - Elasticsearch Connection object
+ * @param  {string} params.arn - execution ARN
+ * @param  {string[]} [params.ignore] - Array of response codes to ignore
+ * @param  {string} params.index - Elasticsearch index alias (default defined in search.js)
+ * @param  {string} params.type - Elasticsearch type (default: execution)
+ * @returns {Promise} Elasticsearch response
+ */
+function deleteExecution({
+  esClient,
+  arn,
+  ignore,
+  index = defaultIndexAlias,
+  type = 'execution',
+}) {
+  return deleteRecord({
+    esClient,
+    id: arn,
+    index,
+    type,
+    ignore,
+  });
+}
+
+/**
+ * Deletes the async operation in Elasticsearch
+ *
+ * @param {Object} params
+ * @param {Object} params.esClient - Elasticsearch Connection object
+ * @param {string} params.id - the async operation ID
+ * @param {string[]} [params.ignore] - Array of response codes to ignore
+ * @param {string} params.index - Elasticsearch index alias (default defined in search.js)
+ * @param {string} params.type - Elasticsearch type (default: asyncOperation)
+ * @returns {Promise} Elasticsearch response
+*/
+function deleteAsyncOperation({
+  esClient,
+  id,
+  ignore,
+  index = defaultIndexAlias,
+  type = 'asyncOperation',
+}) {
+  return deleteRecord({
+    esClient,
+    id,
+    index,
+    type,
+    ignore,
+  });
+}
+
+/**
+ * Deletes the reconciliation report from Elasticsearch
+ *
+ * @param  {Object} params
+ * @param  {Object} params.esClient - Elasticsearch Connection object
+ * @param  {string} params.name - reconciliation report name
+ * @param  {string[]} [params.ignore] - Array of response codes to ignore
+ * @param  {string} params.index - Elasticsearch index alias (default defined in search.js)
+ * @param  {string} params.type - Elasticsearch type (default: reconciliationReport)
+ * @returns {Promise} Elasticsearch response
+ */
+function deleteReconciliationReport({
+  esClient,
+  name,
+  ignore,
+  index = defaultIndexAlias,
+  type = 'reconciliationReport',
+}) {
+  return deleteRecord({
+    esClient,
+    id: name,
+    index,
+    type,
+    ignore,
+  });
+}
+
+/**
+ * Deletes the granule in Elasticsearch
+ *
+ * @param  {Object} params
+ * @param  {Object} params.esClient - Elasticsearch Connection object
+ * @param  {string} params.granuleId - the granule ID
+ * @param  {string} params.collectionId - the collection ID
+ * @param  {string[]} [params.ignore] - Array of response codes to ignore
+ * @param  {string} params.index - Elasticsearch index alias (default defined in search.js)
+ * @param  {string} params.type - Elasticsearch type (default: granule)
+ * @returns {Promise} Elasticsearch response
+ */
+async function deleteGranule({
+  esClient,
+  granuleId,
+  collectionId,
+  ignore,
+  index = defaultIndexAlias,
+  type = 'granule',
+}) {
+  const esGranulesClient = new Search(
+    {},
+    type,
+    index
+  );
+  const granuleEsRecord = await esGranulesClient.get(granuleId, collectionId);
+
+  // When a 'granule' record is deleted, the record is added to 'deletedgranule' type
+  const deletedGranuleDoc = granuleEsRecord;
+  delete deletedGranuleDoc._id;
+  deletedGranuleDoc.timestamp = Date.now();
+  deletedGranuleDoc.deletedAt = Date.now();
+  await genericRecordUpdate(
+    esClient,
+    granuleId,
+    deletedGranuleDoc,
+    index,
+    'deletedgranule',
+    collectionId
+  );
+
+  return await deleteRecord({
+    esClient,
+    id: granuleId,
+    parent: collectionId,
+    index,
+    type,
+    ignore,
+  });
 }
 
 module.exports = {
-  addToLocalES,
   createIndex,
   indexCollection,
   indexProvider,
   indexReconciliationReport,
   indexRule,
   indexGranule,
+  upsertGranule,
   indexPdr,
+  upsertPdr,
   indexExecution,
   indexAsyncOperation,
   deleteRecord,
+  deleteAsyncOperation,
+  updateAsyncOperation,
+  upsertExecution,
+  deleteCollection,
+  deleteProvider,
+  deleteRule,
+  deletePdr,
+  deleteGranule,
+  deleteExecution,
+  deleteReconciliationReport,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/es-client",
-  "version": "10.1.0",
+  "version": "10.1.2-alpha.0",
   "description": "Utilities for working with Elasticsearch",
   "keywords": [
     "CUMULUS",
@@ -37,7 +37,7 @@
     "@elastic/elasticsearch": "^5.6.20",
     "aws-elasticsearch-connector": "8.2.0",
     "aws-sdk": "^2.585.0",
-    "lodash": "~4.17.20",
+    "lodash": "~4.17.21",
     "moment": "2.29.1",
     "p-limit": "^1.2.0"
   },
@@ -45,6 +45,5 @@
     "@cumulus/aws-client": "10.1.0",
     "@cumulus/test-data": "10.1.0",
     "p-each-series": "^2.1.0"
-  },
-  "gitHead": "765ba4733ec97540e28cd64dac702eea3b96c654"
+  }
 }

package/search.js

@@ -197,15 +197,30 @@ class BaseSearch {
     };
   }
 
-  async get(id) {
+  async get(id, parentId) {
     const body = {
       query: {
-        term: {
-          _id: id,
+        bool: {
+          must: [{
+            term: {
+              _id: id,
+            },
+          }],
         },
       },
     };
 
+    if (parentId) {
+      body.query.bool.must.push(
+        {
+          parent_id: {
+            id: parentId,
+            type: this.type,
+          },
+        }
+      );
+    }
+
     logDetails.granuleId = id;
 
     if (!this.client) {
@@ -215,7 +230,7 @@ class BaseSearch {
     const result = await this.client.search({
       index: this.index,
       type: this.type,
-      body: body,
+      body,
     }).then((response) => response.body);
 
     if (result.hits.total > 1) {
@@ -230,6 +245,11 @@ class BaseSearch {
     return resp;
   }
 
+  async exists(id, parentId) {
+    const response = await this.get(id, parentId);
+    return response.detail !== 'Record not found';
+  }
+
   async granulesStats(key, value) {
     const body = {
       query: {

package/testUtils.js

@@ -1,13 +1,14 @@
 const { randomString } = require('@cumulus/common/test-utils');
 
-const { bootstrapElasticSearch } = require('./bootstrap');
+const bootstrap = require('./bootstrap');
+
 const { Search } = require('./search');
 
 const createTestIndex = async () => {
   const esIndex = randomString();
   const esAlias = randomString();
   process.env.ES_INDEX = esIndex;
-  await bootstrapElasticSearch('fakehost', esIndex, esAlias);
+  await bootstrap.bootstrapElasticSearch('fakehost', esIndex, esAlias);
   const esClient = await Search.es('fakehost');
   return { esIndex, esClient };
 };

package/LICENSE

@@ -1,60 +0,0 @@
-Copyright © 2020 United States Government as represented by the Administrator of the National Aeronautics and Space Administration. All Rights Reserved.
-
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICE NSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-
----
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
-
-"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
-
-"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
-
-"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
-
-"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
-
-"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
-
-"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
-
-"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
-
-"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
-
-"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
-
-    You must give any other recipients of the Work or Derivative Works a copy of this License; and
-    You must cause any modified files to carry prominent notices stating that You changed the files; and
-    You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
-    If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
-
-    You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS