feat(Activities): Merges xapi-activities service. (#468)

Author: ryasmi

package.json

@@ -38,7 +38,6 @@
     "npm": ">3.0.0"
   },
   "dependencies": {
-    "@learninglocker/xapi-activities": "4.4.4",
     "@learninglocker/xapi-agents": "4.4.3",
     "accept-language-parser": "^1.5.0",
     "boolean": "^0.2.0",
@@ -95,4 +94,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

src/apps/activities/app.ts

@@ -1,10 +1,10 @@
 /* tslint:disable:max-file-line-count */
-import presenterFactory from '@learninglocker/xapi-activities/dist/expressPresenter';
-import serviceFactory from '@learninglocker/xapi-activities/dist/service';
-import enTranslator from '@learninglocker/xapi-activities/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/activities/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/activities/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/activities/azureStorageRepo/deleteProfileContent.ts

@@ -0,0 +1,18 @@
+import {
+  Aborter,
+  BlobURL,
+} from '@azure/storage-blob';
+import DeleteProfileContentOptions from '../repoFactory/options/DeleteProfileContentOptions';
+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/activities/azureStorageRepo/getProfileContent.ts

@@ -0,0 +1,20 @@
+import { Aborter, BlobURL } from '@azure/storage-blob';
+import GetProfileContentOptions from '../repoFactory/options/GetProfileContentOptions';
+import GetProfileContentResult from '../repoFactory/results/GetProfileContentResult';
+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/activities/azureStorageRepo/index.ts

@@ -0,0 +1,17 @@
+import StorageRepo from '../repoFactory/StorageRepo';
+import clearRepo from './clearRepo';
+import Config from './Config';
+import deleteProfileContent from './deleteProfileContent';
+import getProfileContent from './getProfileContent';
+import storeProfileContent from './storeProfileContent';
+
+export default (config: Config): StorageRepo => {
+  return {
+    clearRepo: clearRepo(config),
+    deleteProfileContent: deleteProfileContent(config),
+    getProfileContent: getProfileContent(config),
+    migrate: async () => Promise.resolve(),
+    rollback: async () => Promise.resolve(),
+    storeProfileContent: storeProfileContent(config),
+  };
+};

src/apps/activities/azureStorageRepo/storeProfileContent.ts

@@ -0,0 +1,48 @@
+import {
+  Aborter,
+  BlobURL,
+  BlockBlobURL,
+  uploadStreamToBlockBlob,
+} from '@azure/storage-blob';
+import { Readable } from 'stream';
+import StoreProfileContentOptions from '../repoFactory/options/StoreProfileContentOptions';
+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: StoreProfileContentOptions): 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/activities/errors/Conflict.ts

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

src/apps/activities/errors/ExpiredClientError.ts

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