Development (#33)

MongoCaleb · jwongmongodb · web-flow · commit f4328367fba3 · 2024-05-31T12:31:38.000-07:00
* update commit hash * add manifest validator action; does not yet check root-level * testing jq instaltion; changing others to pull_request only * force run on jqtest * add further testing * got file checking working. updated manifest file to fail * reset manifest file; clean up actions * BAAS-30360: Add Twilio third party snippets (#32) * main => development (#31) * change production=>main branch * update commit hash * BAAS-30360: add twilio third party snippets * update commit hash * test * Commit performed using Copy Push Files action * Commit performed using Copy Push Files action * Commit performed using Copy Push Files action * test * update commit hash * update commit hash * test * update commit hash * test * update commit hash --------- Co-authored-by: MongoCaleb <32645888+MongoCaleb@users.noreply.github.com> Co-authored-by: ActionBot <caleb.thompson@mongodb.com> Co-authored-by: MongoCaleb <MongoCaleb@users.noreply.github.com> --------- Co-authored-by: jwongmongodb <116834447+jwongmongodb@users.noreply.github.com> Co-authored-by: MongoCaleb <MongoCaleb@users.noreply.github.com>
diff --git a/.github/workflows/Remove-Function-Name-Prefix.yml b/.github/workflows/Remove-Function-Name-Prefix.yml
@@ -2,7 +2,7 @@ name: Remove Function Name Prefixes
 
 on:
   workflow_call:
-  push:
+  pull_request:
 
 jobs:
   remove-function-prefix:
diff --git a/.github/workflows/Update-Commit-Hash.yml b/.github/workflows/Update-Commit-Hash.yml
@@ -1,7 +1,7 @@
 name: Update Commit Hash
 
 on:
-  push:
+  pull_request:
   workflow_dispatch:
 
 jobs:
diff --git a/.github/workflows/Validate-Base-Manifest.yml b/.github/workflows/Validate-Base-Manifest.yml
@@ -0,0 +1,39 @@
+name: "Validate Base Manifest.json"
+
+on:
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      version:
+        type: string
+        required: false
+        description: 'Version of jq to install'
+        default: '1.7'
+      force:
+        type: boolean
+        required: false
+        description: 'Do not check for existing jq installation before continuing.'
+        default: false
+
+jobs:
+  Setup-jq:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: 'Setup jq'
+        uses: dcarbone/install-jq-action@v2
+        with:
+          version: '${{ inputs.version }}'
+          force: '${{ inputs.force }}'
+      - id: validate_manifest
+        run: |
+          for fn in $(jq -r '.' manifest.json | jq -r '.snippetCategories[].metadata'); do
+            fullpath=".$fn"
+            echo "the next file is $fullpath"
+            if test -f $fullpath; then
+              echo "File exists."
+            else 
+              echo "**MANIFEST FILE DOES NOT EXIST**"
+              exit 1
+            fi
+          done
diff --git a/.github/workflows/Validate-Manifests.yml b/.github/workflows/Validate-Manifests.yml
@@ -0,0 +1,22 @@
+name: Validate Manifests
+on: [pull_request]
+
+jobs:
+  validate-github-actions-workflows:
+    name: Validate JSON Schemas
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Validate scehmas
+      uses: dsanders11/json-schema-validate-action@v1.1.2
+      with:
+        schema: ./snippets/manifest-schema.json
+        files: ./snippets/functions/**/**.json 
+    - name: Test
+      run: |
+        content=`cat ./manifest.json`
+        echo $content
+        barf=${{fromJson($content)}}
+        echo ${{ barf }}
diff --git a/latestCommit.md b/latestCommit.md
@@ -1 +1 @@
-8efff924551200067d16409d2cf4cfc212070231
+86bf61d24dc9a0784485282a5063f559f91ad7ee
diff --git a/manifest.json b/manifest.json
@@ -7,6 +7,12 @@
         "metadata": "/snippets/functions/mongodb-crud/manifest.json"
         },
         {
+        "metadata": "/snippets/functions/api-functions/manifest.json"
+        },
+        {
+        "metadata": "/snippets/functions/function-context/manifest.json"
+        },
+        {
         "metadata": "/snippets/triggers/match/manifest.json"
         },
         {
diff --git a/snippets/functions/api-functions/api_callExternalAPI.js b/snippets/functions/api-functions/api_callExternalAPI.js
@@ -0,0 +1,9 @@
+exports = async function(arg){
+  const url = "https://api.stackexchange.com/2.3/answers?key=U4DMV*8nvpm3EOpvf69Rxw((&site=stackoverflow&page=1&pagesize=10&order=desc&sort=activity&filter=default";
+
+  const response = await context.http.get({ url: url })
+  // The response body is a BSON.Binary object, so parse it:
+  const result = EJSON.parse(response.body.text())
+  // console.log(JSON.stringify(result));
+  return result;
+}
diff --git a/snippets/functions/api-functions/manifest.json b/snippets/functions/api-functions/manifest.json
@@ -0,0 +1,13 @@
+{
+    "category": "Function API Calls",
+    "categoryId": "f9edca1b-a841-4037-8e6c-421d547ca160",
+    "viewType": "functionSnippet",
+    "snippets": [
+        {
+        "id": "f812224f-55dd-4192-98d8-59246053940b",
+        "title": "Call an external API from a function",
+        "snippet": "/callExternalAPI.js",
+        "description": "Use the function's context.http to call an external API."
+        }
+    ]
+}
diff --git a/snippets/functions/function-context/context_callFunction.js b/snippets/functions/function-context/context_callFunction.js
@@ -0,0 +1,14 @@
+exports = async function(number1, number2){
+
+  // To call other named functions:
+  var result = context.functions.execute("sum", number1, number2);
+
+  return result;
+};
+
+// This examples calls a function named "sum" that looks like this:
+/*
+  exports = async function(number1, number2) {
+    return number1 + number2
+  };
+*/
diff --git a/snippets/functions/function-context/manifest.json b/snippets/functions/function-context/manifest.json
@@ -0,0 +1,13 @@
+{
+    "category": "Function Context Examples",
+    "categoryId": "38b0fd8f-fefe-4cb4-838c-a094d61e299e",
+    "viewType": "functionSnippet",
+    "snippets": [
+        {
+        "id": "c2171069-9b17-41b0-bb5c-475a141a13ed",
+        "title": "Call another function from a function",
+        "snippet": "/callFunction.js",
+        "description": "Use the Function context to call another function."
+        }
+    ]
+}
diff --git a/snippets/functions/mongodb-crud/crud_DeleteMany.js b/snippets/functions/mongodb-crud/crud_DeleteMany.js
@@ -0,0 +1,17 @@
+exports = async function(args){
+  console.log(JSON.stringify(args));
+  
+  var serviceName = "mongodb-atlas";
+  var dbName = "sample_supplies";
+  var collName = "sales";
+
+  var collection = context.services.get(serviceName).db(dbName).collection(collName);
+  
+  try {
+    deleteResult = await collection.deleteMany(args);
+    return deleteResult["deletedCount"];
+  } catch(err) {
+    console.log("Failed to delete item: ", err.message);
+    return { error: err.message };
+  }
+};
diff --git a/snippets/functions/mongodb-crud/crud_DeleteOne.js b/snippets/functions/mongodb-crud/crud_DeleteOne.js
@@ -0,0 +1,19 @@
+exports = async function(deleteFilter){
+  var serviceName = "mongodb-atlas";
+  var dbName = "sample_supplies";
+  var collName = "sales";
+
+  // example deleteFilter:
+  // { _id: ObjectId("123")}
+  
+  var collection = context.services.get(serviceName).db(dbName).collection(collName);
+  
+  try {
+    deleteResult = await collection.deleteOne(deleteFilter);
+    return deleteResult["deletedCount"];
+
+  } catch(err) {
+    console.log("Failed to delete item: ", err.message);
+    return { error: err.message };
+  }
+};
diff --git a/snippets/functions/mongodb-crud/crud_Find.js b/snippets/functions/mongodb-crud/crud_Find.js
@@ -0,0 +1,21 @@
+exports = async function(args){
+  // Find the name of the MongoDB service you want to use (see "Linked Data Sources" tab)
+  var serviceName = "mongodb-atlas";
+
+  // Update these to reflect your db/collection
+  var dbName = "sample_supplies";
+  var collName = "sales";
+
+  // Get a collection from the context
+  var collection = context.services.get(serviceName).db(dbName).collection(collName);
+
+  try {
+    docs = await collection.find(args);
+    console.log(JSON.stringify(docs));
+    return docs;
+
+  } catch(err) {
+    console.log("Failed to find item: ", err.message);
+    return { error: err.message };
+  }
+}
diff --git a/snippets/functions/mongodb-crud/crud_FindOne.js b/snippets/functions/mongodb-crud/crud_FindOne.js
@@ -0,0 +1,17 @@
+exports = async function(saleId){
+  var serviceName = "mongodb-atlas";
+  var dbName = "sample_supplies";
+  var collName = "sales";
+
+  var collection = context.services.get(serviceName).db(dbName).collection(collName);
+  const query = { "_id": new BSON.ObjectId(saleId) };
+  try {
+    doc = await collection.findOne(query);
+    console.log('found:', JSON.stringify(doc));
+    return doc;
+
+  } catch(err) {
+    console.log("Failed to find item: ", err.message);
+    return { error: err.message };
+  }
+};
diff --git a/snippets/functions/mongodb-crud/crud_InsertMany.js b/snippets/functions/mongodb-crud/crud_InsertMany.js
@@ -0,0 +1,23 @@
+exports = async function(args){
+  // Find the name of the MongoDB service you want to use (see "Linked Data Sources" tab)
+  var serviceName = "mongodb-atlas";
+
+  // Update these to reflect your db/collection
+  var dbName = "sample_supplies";
+  var collName = "sales";
+
+  // Get a collection from the context
+  var collection = context.services.get(serviceName).db(dbName).collection(collName);
+
+  try {
+    insertResult = await collection.insertMany(args);
+    console.log('insertResult ids:', insertResult.insertedIds);
+    console.log('insertResult length:', insertResult.insertedIds.length);
+    console.log('returning', JSON.stringify(insertResult));
+    return insertResult;
+
+  } catch(err) {
+    console.log("Failed to insert item(s): ", err.message);
+    return { error: err.message };
+  }
+};
diff --git a/snippets/functions/mongodb-crud/crud_InsertOne.js b/snippets/functions/mongodb-crud/crud_InsertOne.js
@@ -0,0 +1,21 @@
+exports = async function(args){
+  // Find the name of the MongoDB service you want to use (see "Linked Data Sources" tab)
+  var serviceName = "mongodb-atlas";
+
+  // Update these to reflect your db/collection
+  var dbName = "sample_supplies";
+  var collName = "sales";
+
+  // Get a collection from the context
+  var collection = context.services.get(serviceName).db(dbName).collection(collName);
+  
+  try {
+    // Execute an InsertOne in MongoDB 
+    insertResult = await collection.insertOne(args);
+    return insertResult;
+
+  } catch(err) {
+    console.log("Failed to insert item: ", err.message);
+    return { error: err.message };
+  }
+};
diff --git a/snippets/functions/mongodb-crud/crud_Project.js b/snippets/functions/mongodb-crud/crud_Project.js
@@ -0,0 +1,23 @@
+exports = async function(saleId, projection={}){
+  var serviceName = "mongodb-atlas";
+  var dbName = "sample_supplies";
+  var collName = "sales";
+
+  var collection = context.services.get(serviceName).db(dbName).collection(collName);
+  const query = { "_id": new BSON.ObjectId(saleId) };
+  // An example of the projection object that might be passed in:
+  /*const projection = {
+    _id:0,
+    storeLocation:1,
+    items: 1
+  }*/
+  try {
+    doc = await collection.findOne(query, projection);
+    console.log('found:', JSON.stringify(doc));
+    return doc;
+
+  } catch(err) {
+    console.log("Failed to find item: ", err.message);
+    return { error: err.message };
+  }
+};
diff --git a/snippets/functions/mongodb-crud/crud_Replace.js b/snippets/functions/mongodb-crud/crud_Replace.js
@@ -0,0 +1,29 @@
+exports = async function(productId, replacement){
+  console.log(productId);
+  console.log(replacement);
+  // Find the name of the MongoDB service you want to use (see "Linked Data Sources" tab)
+  var serviceName = "mongodb-atlas";
+
+  // Update these to reflect your db/collection
+  var dbName = "sample_supplies";
+  var collName = "sales";
+
+  // Get a collection from the context
+  var collection = context.services.get(serviceName).db(dbName).collection(collName);
+
+  const query = { "_id": BSON.ObjectId(productId) };
+  // an example replacement ojbect:
+  /*const replacement = {
+      "storeLocation": "East Appleton",
+      "couponUsed": true,
+  };*/
+
+const options = { "returnNewDocument": true };
+
+  try {
+    return await collection.findOneAndReplace(query, replacement, options);
+  } catch(err) {
+    console.log("Failed to replace item: ", err.message);
+    return { error: err.message };
+  }
+};
diff --git a/snippets/functions/mongodb-crud/crud_UpdateMany.js b/snippets/functions/mongodb-crud/crud_UpdateMany.js
@@ -0,0 +1,30 @@
+exports = async function(query, updateFilter){
+  // Find the name of the MongoDB service you want to use (see "Linked Data Sources" tab)
+  var serviceName = "mongodb-atlas";
+
+  // Update these to reflect your db/collection
+  var dbName = "sample_supplies";
+  var collName = "sales";
+
+  // Get a collection from the context
+  var collection = context.services.get(serviceName).db(dbName).collection(collName);
+
+  // Exampke update filter:
+  /*const updateFilter = {
+    "$set": {
+      "storeId": storeId,
+    }
+  };*/
+  
+  const options = { "upsert": false };
+
+  try {
+    updateResult = await collection.updateOne(query, updateFilter, options);
+    console.log(JSON.stringify(updateResult));
+    return updateResult;
+
+  } catch(err) {
+    console.log("Failed to update item(s): ", err.message);
+    return { error: err.message };
+  }
+};
diff --git a/snippets/functions/mongodb-crud/crud_UpdateOne.js b/snippets/functions/mongodb-crud/crud_UpdateOne.js
@@ -0,0 +1,27 @@
+exports = async function(productIdToUpdate, updateFilter){
+  var serviceName = "mongodb-atlas";
+  var dbName = "sample_supplies";
+  var collName = "sales";
+  var collection = context.services.get(serviceName).db(dbName).collection(collName);
+
+  const query = { "_id": productIdToUpdate };
+  
+  // example update filter:
+  /*const updatefilter = {
+    "$set": {
+      "price": 20.99,
+    }
+  };*/
+  
+  const options = { "upsert": false };
+  
+  try {
+    updateResult = await collection.updateOne(query, updateFilter, options);
+    console.log(JSON.stringify(updateResult));
+    return updateResult;
+
+  } catch(err) {
+    console.log("Failed to update item: ", err.message);
+    return { error: err.message };
+  }
+};
diff --git a/snippets/functions/mongodb-crud/manifest.json b/snippets/functions/mongodb-crud/manifest.json
diff --git a/snippets/functions/third-party/manifest.json b/snippets/functions/third-party/manifest.json
diff --git a/snippets/functions/third-party/twilio.js b/snippets/functions/third-party/twilio.js
diff --git a/snippets/manifest-schema.json b/snippets/manifest-schema.json

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-8efff924551200067d16409d2cf4cfc212070231`
	`1`	`+86bf61d24dc9a0784485282a5063f559f91ad7ee`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,12 @@`
`7`	`7`	`"metadata": "/snippets/functions/mongodb-crud/manifest.json"`
`8`	`8`	`},`
`9`	`9`	`{`
	`10`	`+ "metadata": "/snippets/functions/api-functions/manifest.json"`
	`11`	`+ },`
	`12`	`+ {`
	`13`	`+ "metadata": "/snippets/functions/function-context/manifest.json"`
	`14`	`+ },`
	`15`	`+ {`
`10`	`16`	`"metadata": "/snippets/triggers/match/manifest.json"`
`11`	`17`	`},`
`12`	`18`	`{`