Initial push of sandbox creation endpoint

Author: cw00dw0rd

README.md

@@ -0,0 +1,10 @@
+# Sandbox creation endpoint for use with tutorials
+To use locally, zip entire directory and install service on system database.
+
+Currently, endpoint is accessible via https://a0434a558688.arangodb.cloud:8529/_db/_system/tutorialDB/tutorialDB
+
+**/tutorialDB**
+* Returns dbName, username, password, hostname address
+* Creates tutorialInstances collection that has all existing username and database information.
+* Deletes databases every 4 hours, checks once an hour.
+* When a database is dropped some information, including email is transferred to expiredtutorialInstances collection.

index.js

@@ -6,11 +6,11 @@ const users = require("@arangodb/users");
 const router = createRouter();
 const joi = require('joi');
 
-const aisisInstances = "aisisInstances"
+const collectionName = db._collection("tutorialInstances");
 
 module.context.use(router);
 
-router.post('/createDB', function (req,res) {
+router.post('/tutorialDB', function (req,res) {
   const data = req.body;
   const dbName = data.dbName ? data.dbName : randomStringGenerator();
   const username = data.username ? data.username : randomStringGenerator();
@@ -51,7 +51,7 @@ router.post('/createDB', function (req,res) {
       "port": ${port},
       "email": ${email},
       "timestamp": DATE_NOW()
-    } INTO aisisInstances`
+    } INTO ${collectionName}`;
 
     res.send({dbName, username, password, hostname, port});
   }
@@ -63,5 +63,5 @@ router.post('/createDB', function (req,res) {
 
 function randomStringGenerator() {
   // Database name must start with letter.
-  return  "ML" + Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
+  return  "TUT" + Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
 }

manifest.json

@@ -1,6 +1,6 @@
 {
   "engines": {
-    "arangodb": "^3.5.0"
+    "arangodb": "^3.6.0"
   },
   "main": "index.js",
   "scripts": {

scripts/expire.js

@@ -2,24 +2,27 @@
 const { aql, query, db } = require("@arangodb");
 const users = require("@arangodb/users");
 
-const expirationTime = (336 * 60 * 60 * 1000)
-const expired = []
+const expirationTime = (4 * 60 * 60 * 1000) // 4 hours
+const expired = [];
 
 let dbs = query`
-  FOR i IN aisisInstances
-  RETURN {key: i._key, dbName: i.dbName, timestamp: i.timestamp}`
+  FOR i IN tutorialInstances
+  RETURN {key: i._key, dbName: i.dbName, timestamp: i.timestamp, username: i.username}`;
 
 dbs.toArray().map((d) => {
-  (Date.now() - expirationTime ) > d.timestamp ? removeDatabase(d.dbName, d.key) : ''
+  (Date.now() - expirationTime ) > d.timestamp ? removeDatabase(d.dbName, d.key, d.username) : ''
 })
 
-query`
+let cleanupCollection = query`
 FOR key IN ${expired}
-REMOVE { _key: key } IN aisisInstances
-`
+FOR i IN tutorialInstances
+FILTER i._key
+INSERT {email: i.email, username: i.username, dbName: i.dbName} INTO expiredtutorialInstances
+REMOVE { _key: i._key } IN tutorialInstances`;
 
-function removeDatabase(dbName, key) {
-  console.log(db._engineStats())
-  db._dropDatabase(dbName)
-  expired.push(key)
+function removeDatabase(dbName, key, username) {
+  console.log(db._engineStats());
+  users.remove(username);
+  db._dropDatabase(dbName);
+  expired.push(key);
 }

scripts/setup.js

@@ -1,20 +1,26 @@
 'use strict';
 const db = require('@arangodb').db;
-const collectionName = 'aisisInstances';
+const collectionName = 'tutorialInstances';
+const expiredCollectionName = "expired"+collectionName;
 
+// Creates collection to hold current user and instance information, to be deleted
 if (!db._collection(collectionName)) {
   db._createDocumentCollection(collectionName);
 }
+// Creates collection to hold expired documents
+if (!db._collection(expiredCollectionName)) {
+  db._createDocumentCollection(expiredCollectionName);
+}
 const queues = require('@arangodb/foxx/queues');
-const queue = queues.create('expirationQueue');
+const queue = queues.create('tutorialExpirationQueue');
 
 // Creates the expire job to check if databases should be expired and dropped.
 queue.push(
-  {mount: '/createDB', name: 'expire'},
+  {mount: '/tutorialDB', name: 'expire'},
   {},
   {
     repeatTimes: Infinity,
     repeatUntil: -1, // Forever
-    repeatDelay: (24 * 60 * 60 * 1000) // Daily
+    repeatDelay: (60 * 60 * 1000) // Every hour
   }
 );