feat(jsbattle): store challenge progress on server side

Author: jamro

packages/jsbattle-docs/docs/configuration.md

@@ -128,8 +128,6 @@ List of all settings of JsBattle:
 }
 ```
 
-
-
 ## Environment variables
 
 Part of the configuration could be provided as env vars. To disable this feature set `config.skipEnv` to `true`;

packages/jsbattle-docs/docs/img/puml/ai.png

@@ -123,6 +123,8 @@ class MockServer {
         "/api/profile": "/profile",
         "/api/:a/:b": "/:a,:b",
         "/api/:a/:b/:c": "/:a,:b/:c",
+        "/api/:a/:b/:c/:d": "/:a,:b/:c/:d",
+        "/api/:a/:b/:c/:d/:e": "/:a,:b/:c/:d/:e",
         "/api/*": "/$1"
       }))
       server.use(router)

packages/jsbattle-docs/docs/img/puml/infrastructure.png

@@ -239,6 +239,26 @@
       "modifiedAt": "2020-02-23T08:28:04.922Z"
     }
   ],
+  "user,challenges": [
+    {
+      "id": "challenge-8UCUaNvC",
+      "challengeId": "challenge-8UCUaNvC",
+      "code": "importScripts('lib/tank.js');\n\n// Don't know where to start?\n// Read Getting Started in \"Docs\" section \n\ntank.init(function(settings, info) {\n\t// initialize tank here\n  \n});\n\ntank.loop(function(state, control) {\n\tcontrol.DEBUG = {msg: 'hello from 1st challenge'}\n  \n});\n\n\n",
+      "completed": true
+    },
+    {
+      "id": "challenge-Du7tyrCB",
+      "challengeId": "challenge-Du7tyrCB",
+      "code": "importScripts('lib/tank.js');\n\n// Don't know where to start?\n// Read Getting Started in \"Docs\" section \n\ntank.init(function(settings, info) {\n\t// initialize tank here\n  \n});\n\ntank.loop(function(state, control) {\n\tcontrol.DEBUG = {msg: 'how to solve that?'}\n  \n});\n\n\n",
+      "completed": false
+    },
+    {
+      "id": "challenge-4syTf6ph",
+      "challengeId": "challenge-4syTf6ph",
+      "code": "importScripts('lib/tank.js');\n\n// Don't know where to start?\n// Read Getting Started in \"Docs\" section \n\ntank.init(function(settings, info) {\n\t// initialize tank here\n  \n});\n\ntank.loop(function(state, control) {\n\tcontrol.DEBUG = {msg: 'locked'}\n  \n});\n\n\n",
+      "completed": false
+    }
+  ],
   "authMethods": {
     "mock": {
       "name": "Mock",

packages/jsbattle-docs/docs/img/puml/microservices.png

@@ -191,7 +191,7 @@ module.exports = {
         "no-throw-literal": "error",
         "no-trailing-spaces": "error",
         "no-undef-init": "error",
-        "no-undefined": "error",
+        "no-undefined": "off",
         "no-unmodified-loop-condition": "error",
         "no-unneeded-ternary": "error",
         "no-unused-expressions": "error",

packages/jsbattle-docs/docs/img/puml/overview.png

@@ -0,0 +1,40 @@
+#!/usr/bin/env node
+
+// use that runner to work on jsbattle-webpage in dev mode.
+// Simply run
+// ```
+//  $ packages/jsbattle-server/app/runner-weppage-dev-proxy.js
+//  $ cd packages/jsbattle-webpage
+//  $ npm run start:dev
+// ```
+
+const Gateway = require('./Gateway.js');
+const path = require('path');
+
+let gateway = new Gateway();
+let config = {
+  "loglevel": "debug",
+  "web": {
+    "webroot": path.join(__dirname, 'public'),
+    "host": "127.0.0.1",
+    "baseUrl": "http://localhost:8080",
+    "port": "9000",
+    "gaCode": "AB-123456789-Z"
+  },
+  "auth": {
+    "enabled": true,
+    "admins": [
+      {
+        provider: 'github',
+        username: 'jamro'
+      },
+      {
+        provider: 'mock',
+        username: 'mock'
+      }
+    ],
+    "providers": [{ "name": "mock" }]
+  }
+};
+gateway.init(config).then(() => gateway.start())
+.catch(console.error);

packages/jsbattle-docs/docs/img/puml/packages.png

@@ -64,7 +64,10 @@ class ApiGatewayService extends Service {
                   "POST scripts": "scriptStore.createUserScript",
                   "PATCH scripts/:id": "scriptStore.updateUserScript",
                   "GET scripts/:id": "scriptStore.getUserScript",
-                  "DELETE scripts/:id": "scriptStore.deleteUserScript"
+                  "DELETE scripts/:id": "scriptStore.deleteUserScript",
+                  "GET challenges": "challenges.listUserChallanges",
+                  "GET challenges/:id": "challenges.getUserChallanges",
+                  "PATCH challenges/:id": "challenges.updateUserChallanges",
                 },
                 bodyParsers: {
                   json: true,

packages/jsbattle-docs/docs/img/puml/renderer.png

@@ -0,0 +1,137 @@
+const Service = require("moleculer").Service;
+const DbService = require("moleculer-db");
+const { ValidationError } = require("moleculer").Errors;
+const _ = require('lodash');
+const getDbAdapterConfig = require("../lib/getDbAdapterConfig.js");
+
+class ChallengeService extends Service {
+
+  constructor(broker) {
+    super(broker);
+    let adapterConfig = getDbAdapterConfig(broker.serviceConfig.data, 'scriptStore')
+
+    this.parseServiceSchema({
+      ...adapterConfig,
+      name: "challenges",
+      mixins: [DbService],
+      settings: {
+        idField: 'id',
+        fields: [
+          "id",
+          "challengeId",
+          "userId",
+          "code",
+          "completed",
+          "modifiedAt"
+        ],
+        entityValidator: {
+          userId: { type: "string", min: 1, max: 32 },
+          challengeId: { type: "string", min: 1, max: 32 },
+          completed: { type: "boolean", min: 1, max: 255 },
+          code: { type: "string", min: 0, max: 65536 },
+          modifiedAt: "date"
+        }
+      },
+      dependencies: ['userStore'],
+      actions: {
+        listUserChallanges: this.listUserChallanges,
+        getUserChallanges: this.getUserChallanges,
+        updateUserChallanges: this.updateUserChallanges,
+      },
+      hooks: {
+        before: {
+          create: [
+            function addDefaults(ctx) {
+              const userId = ctx.meta.user ? ctx.meta.user.id : '';
+              ctx.params.userId = ctx.params.userId || userId;
+              ctx.params.completed = false;
+              ctx.params.code = "importScripts('lib/tank.js');\n\n// Don't know where to start?\n// Read Getting Started in \"Docs\" section \n\ntank.init(function(settings, info) {\n\t// initialize tank here\n  \n});\n\ntank.loop(function(state, control) {\n\t// write your tank logic here\n  \n});\n\n\n";
+              ctx.params.modifiedAt = new Date();
+              ctx.params = _.omit(ctx.params, ['id']);
+              return ctx;
+            }
+          ],
+          update: [
+            function omitReadOnly(ctx) {
+              ctx.params = _.omit(ctx.params, ['userId']);
+              return ctx;
+            }
+          ]
+        }
+      }
+    });
+  }
+
+  listUserChallanges(ctx) {
+    const userId = ctx.meta.user ? ctx.meta.user.id : null;
+    if(!userId) {
+      throw new ValidationError('Not Authorized!', 401);
+    }
+    return ctx.call('challenges.list', {
+      query: {
+        userId: userId
+      },
+      fields: [
+        "challengeId",
+        "completed"
+      ]
+    })
+  }
+
+  async getUserChallanges(ctx) {
+    const userId = ctx.meta.user ? ctx.meta.user.id : null;
+    if(!userId) {
+      throw new ValidationError('Not Authorized!', 401);
+    }
+    const challengeId = ctx.params.id
+    let response = await ctx.call('challenges.find', {query: {
+      userId: userId,
+      challengeId: challengeId
+    }});
+    if(response.length > 0) {
+      return response[0];
+    }
+    return ctx.call('challenges.create', {
+      userId: userId,
+      challengeId: challengeId
+    });
+  }
+
+  async updateUserChallanges(ctx) {
+    const userId = ctx.meta.user ? ctx.meta.user.id : null;
+    if(!userId) {
+      throw new ValidationError('Not Authorized!', 401);
+    }
+    const challengeId = ctx.params.id
+    let response = await ctx.call('challenges.find', {query: {
+      userId: userId,
+      challengeId: challengeId
+    }});
+    let challenge;
+    if(response.length > 0) {
+      challenge = response[0]
+    } else {
+      challenge = await ctx.call('challenges.create', {
+        userId: userId,
+        challengeId: challengeId
+      });
+    }
+
+    let updateData = {
+      id: challenge.id,
+      modifiedAt: new Date()
+    }
+    if(ctx.params.code !== undefined) {
+      updateData.code = ctx.params.code;
+    }
+    if(ctx.params.completed !== undefined) {
+      updateData.completed = ctx.params.completed;
+    }
+
+    return ctx.call('challenges.update', updateData);
+
+  }
+
+}
+
+module.exports = ChallengeService;