feat(State): Merges xapi-state service. (#465)

Author: ryasmi

package.json

@@ -17,7 +17,7 @@
   "scripts": {
     "start": "node dist/server.js",
     "build": "tsc",
-    "test": "SERVICE_AWAIT_UPDATES=true mocha $(find dist -name '*.test.js') --timeout 6000 --exit",
+    "test": "SERVICE_AWAIT_UPDATES=true AUTH_REPO=test mocha $(find dist -name '*.test.js') --timeout 6000 --exit",
     "test-s3": "MODELS_REPO=memory STORAGE_REPO=s3 npm run test",
     "test-google": "MODELS_REPO=memory STORAGE_REPO=google npm run test",
     "test-azure": "MODELS_REPO=memory STORAGE_REPO=azure npm run test",
@@ -40,7 +40,6 @@
   "dependencies": {
     "@learninglocker/xapi-activities": "4.4.4",
     "@learninglocker/xapi-agents": "4.4.3",
-    "@learninglocker/xapi-state": "^4.4.0",
     "accept-language-parser": "^1.5.0",
     "boolean": "^0.2.0",
     "dotenv": "^5.0.0",
@@ -77,6 +76,7 @@
     "@types/object-hash": "1.3.0",
     "@types/redis": "2.8.6",
     "@types/source-map-support": "0.5.0",
+    "@types/supertest": "2.0.8",
     "@types/uuid": "3.4.5",
     "@types/winston": "2.4.4",
     "colors": "1.3.3",
@@ -86,6 +86,7 @@
     "rimraf": "2.7.1",
     "shelljs": "0.8.3",
     "simple-git": "1.126.0",
+    "supertest": "3.4.2",
     "tslint": "5.19.0",
     "tslint-consistent-codestyle": "1.15.1",
     "tslint-immutable": "4.9.1",
@@ -94,4 +95,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

src/apps/states/app.ts

@@ -1,10 +1,10 @@
 /* tslint:disable:max-file-line-count */
-import presenterFactory from '@learninglocker/xapi-state/dist/expressPresenter';
-import serviceFactory from '@learninglocker/xapi-state/dist/service';
-import enTranslator from '@learninglocker/xapi-state/dist/translatorFactory/en';
 import { Router } from 'express';
 import AppConfig from './AppConfig';
+import presenterFactory from './expressPresenter';
 import repoFactory from './repo/factory';
+import serviceFactory from './service';
+import enTranslator from './translatorFactory/en';
 
 export default (appConfig: AppConfig): Router => {
   const translator = enTranslator;

src/apps/states/azureStorageRepo/Config.ts

@@ -0,0 +1,6 @@
+import { ContainerURL } from '@azure/storage-blob';
+
+ export default interface Config {
+  readonly containerUrl: ContainerURL;
+  readonly subFolder: string;
+}

src/apps/states/azureStorageRepo/clearRepo.ts

@@ -0,0 +1,27 @@
+import {
+  Aborter,
+  BlobURL,
+  Models,
+} from '@azure/storage-blob';
+import Config from './Config';
+
+export default (config: Config) => {
+  return async (): Promise<void> => {
+    // tslint:disable-next-line:no-let
+    let marker;
+    do {
+      const listBlobsResponse: Models.ContainerListBlobFlatSegmentResponse =
+        await config.containerUrl.listBlobFlatSegment(Aborter.none, marker);
+      marker = listBlobsResponse.nextMarker;
+      const deletePromises = listBlobsResponse.segment.blobItems.map(
+        async (blobItem: Models.BlobItem) => {
+          const blobUrl = BlobURL.fromContainerURL(config.containerUrl, blobItem.name);
+          if (blobItem.name.startsWith(config.subFolder)) {
+            await blobUrl.delete(Aborter.none);
+          }
+        },
+      );
+      await Promise.all(deletePromises);
+    } while (marker !== '');
+  };
+};

src/apps/states/azureStorageRepo/deleteStateContent.ts

@@ -0,0 +1,19 @@
+
+import {
+  Aborter,
+  BlobURL,
+} from '@azure/storage-blob';
+import DeleteProfileContentOptions from '../repoFactory/options/DeleteStateContentOptions';
+import getStorageDir from '../utils/getStorageDir';
+import Config from './Config';
+
+ export default (config: Config) => {
+  return async (opts: DeleteProfileContentOptions): Promise<void> => {
+    const profileDir = getStorageDir({ subfolder: config.subFolder, lrs_id: opts.lrs_id });
+    const filePath = `${profileDir}/${opts.key}`;
+
+     const blobUrl = BlobURL.fromContainerURL(config.containerUrl, filePath);
+
+     await blobUrl.delete(Aborter.none);
+  };
+};

src/apps/states/azureStorageRepo/deleteStatesContent.ts

@@ -0,0 +1,25 @@
+import {
+  Aborter,
+  BlobURL,
+} from '@azure/storage-blob';
+import DeleteStatesContentOptions from '../repoFactory/options/DeleteStatesContentOptions';
+import getStorageDir from '../utils/getStorageDir';
+import Config from './Config';
+
+export default (config: Config) => {
+  return async (opts: DeleteStatesContentOptions): Promise<void> => {
+    const dir = getStorageDir({ subfolder: config.subFolder, lrs_id: opts.lrs_id });
+
+    if (opts.keys.length === 0) {
+      return;
+    }
+
+    const promises = opts.keys.map(async (key) => {
+      const filePath = `${dir}/${key}`;
+      const blobUrl = BlobURL.fromContainerURL(config.containerUrl, filePath);
+      await blobUrl.delete(Aborter.none);
+    });
+
+    await Promise.all(promises);
+  };
+};

src/apps/states/azureStorageRepo/getStateContent.ts

@@ -0,0 +1,20 @@
+import { Aborter, BlobURL } from '@azure/storage-blob';
+import GetProfileContentOptions from '../repoFactory/options/GetStateContentOptions';
+import GetProfileContentResult from '../repoFactory/results/GetStateContentResult';
+import getStorageDir from '../utils/getStorageDir';
+import Config from './Config';
+
+ export default (config: Config) => {
+  return async (opts: GetProfileContentOptions): Promise<GetProfileContentResult> => {
+    const profileDir = getStorageDir({ subfolder: config.subFolder, lrs_id: opts.lrs_id });
+    const filePath = `${profileDir}/${opts.key}`;
+
+     const blobUrl = BlobURL.fromContainerURL(config.containerUrl, filePath);
+    const content = (await blobUrl.download(Aborter.none, 0)).readableStreamBody;
+    if (content === undefined) {
+      throw new Error('Blob not found');
+    }
+
+     return { content };
+  };
+};

src/apps/states/azureStorageRepo/index.ts

@@ -0,0 +1,19 @@
+import StorageRepo from '../repoFactory/StorageRepo';
+import clearRepo from './clearRepo';
+import Config from './Config';
+import deleteStateContent from './deleteStateContent';
+import deleteStatesContent from './deleteStatesContent';
+import getStateContent from './getStateContent';
+import storeStateContent from './storeStateContent';
+
+export default (config: Config): StorageRepo => {
+  return {
+    clearRepo: clearRepo(config),
+    deleteStateContent: deleteStateContent(config),
+    deleteStatesContent: deleteStatesContent(config),
+    getStateContent: getStateContent(config),
+    migrate: async () => Promise.resolve(),
+    rollback: async () => Promise.resolve(),
+    storeStateContent: storeStateContent(config),
+  };
+};

src/apps/states/azureStorageRepo/storeStateContent.ts

@@ -0,0 +1,48 @@
+import {
+  Aborter,
+  BlobURL,
+  BlockBlobURL,
+  uploadStreamToBlockBlob,
+} from '@azure/storage-blob';
+import { Readable } from 'stream';
+import StoreStateContentOptions from '../repoFactory/options/StoreStateContentOptions';
+import getStorageDir from '../utils/getStorageDir';
+import Config from './Config';
+
+const BYTES_IN_KILOBYTES = 1024;
+const KILOBYTES_IN_MEGABYTES = 1024;
+const FOUR = 4;
+
+// https://github.com/Azure/azure-storage-js/blob/master/blob/samples/highlevel.sample.js
+const BUFFER_SIZE = FOUR * KILOBYTES_IN_MEGABYTES * BYTES_IN_KILOBYTES; // 4MB
+const MAX_BUFFERS = 20;
+
+export default (config: Config) => {
+  return async (opts: StoreStateContentOptions): Promise<void> => {
+    return new Promise<void>(async (resolve, reject) => {
+      const profileDir = getStorageDir({
+        subfolder: config.subFolder,
+        lrs_id: opts.lrs_id,
+      });
+      const filePath = `${profileDir}/${opts.key}`;
+
+      const blobUrl = BlobURL.fromContainerURL(config.containerUrl, filePath);
+      const blockBlobUrl = BlockBlobURL.fromBlobURL(blobUrl);
+
+      opts.content.on('error', reject);
+
+      try {
+        await uploadStreamToBlockBlob(
+          Aborter.none,
+          opts.content as Readable,
+          blockBlobUrl,
+          BUFFER_SIZE,
+          MAX_BUFFERS,
+        );
+      } catch (err) {
+        reject(err);
+      }
+      resolve();
+    });
+  };
+};

src/apps/states/errors/ExpiredClientError.ts

@@ -0,0 +1,8 @@
+/* tslint:disable:no-class */
+import BaseError from 'jscommons/dist/errors/BaseError';
+
+export default class extends BaseError {
+  constructor() {
+    super();
+  }
+}