Updated file-storage (#5)

* updated readme files

* updated readme files

* added short description

* added definitions

* updated tests

* updated packages versions and README files

* updated file-storage README.md

* added core package

* added core package

* fixed imports

* added more types for file-storage

* added more types for file-storage

* added tests

* fixed CI

* clean up

* updated test config

* fixed dependencies

.github/workflows/ci.yaml

@@ -0,0 +1,26 @@
+name: 'CI'
+on:
+  pull_request:
+    branches:
+      - main
+    types:
+      - opened
+      - synchronize
+      - edited
+  workflow_call:
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install packages
+        run: npm install
+      - name: Compile
+        run: npm run compile
+      - name: Run tests
+        run: npm run test

.github/workflows/release.yaml

@@ -1,8 +1,7 @@
-name: Continuous deployment
+name: 'CD release'
 on:
-  push:
-    branches:
-      - publish
+  release:
+    types: [prereleased, released]
 
 env:
   NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -16,6 +15,11 @@ jobs:
         with:
           node-version: '16.x'
           registry-url: 'https://registry.npmjs.org'
-      - run: npm install
-      - run: npm run compile
-      - run: npm publish --workspaces --access public
+      - name: Install packages
+        run: npm install
+      - name: Compile
+        run: npm run compile
+      - name: Run tests
+        run: npm run test
+      - name: Publish package
+        run: npm publish --workspaces --access public

README.md

@@ -1,12 +1,37 @@
 # Cere DDC SDK for JavaScript
 
+## Packages
+
+- [content-addressable-storage](packages/content-addressable-storage/README.md)
+- [key-value-storage](packages/key-value-storage/README.md)
+- [file-storage](packages/file-storage/README.md)
+- [proto](packages/proto/README.md)
+- [core](packages/core/README.md)
+
+## Use case
+
+- `content-addressable-storage` use when need simple upload data to DDC as 1 unit
+- `key-value-storage` use when need store data by key
+- `file-storage` use when need to upload large data by chunks
+
+## Definitions
+
+- `DDC` - decentralized data cloud, product of cerebellum network for storing data
+- `piece` - abstraction which represents a unit of data stored in the DDC.
+Doesn't have fixed size and can represent fully logically completed data or part of it.
+
+## Dependencies
+
+- protobuf compiler (`protoc`) for compiling *.proto model files.
+- typescript `4.5.5+`
+
 ## Compilation
 
 To compile the code in bulk:
 
-```shell
-npm run compile -ws
-```
+- clone repository
+- download required modules ```npm install```
+- compile files ```npm run compile```
 
 ## Testing
 

docker-compose/docker-compose.yml

@@ -0,0 +1,70 @@
+version: "3"
+
+services:
+  ddc-cdn-node:
+    container_name: "ddc-cdn-node"
+    image: 'cerebellumnetwork/ddc-gateway-node:dev-latest'
+    environment:
+      - 'HTTP_PORT=8080'
+      - 'HTTP_ADDRESS=http://localhost:8080'
+      - 'LOG_LEVEL=debug'
+      - 'LOG_JSON_FORMAT=false'
+      - 'TEST_ENABLED=true'
+    ports:
+      - '8080:8080'
+    healthcheck:
+      test: wget --no-verbose --tries=1 --spider http://localhost:8080/info || exit 1
+      interval: 3s
+      timeout: 1s
+      retries: 5
+
+  ddc-storage-node-0:
+    container_name: "ddc-storage-node-0"
+    image: 'cerebellumnetwork/ddc-storage-node:dev-latest'
+    environment:
+      - 'HTTP_PORT=8090'
+      - 'HTTP_ADDRESS=http://localhost:8090'
+      - 'LOG_LEVEL=info'
+      - 'LOG_JSON_FORMAT=false'
+      - 'TEST_ENABLED=true'
+    ports:
+      - '8090:8090'
+    healthcheck:
+      test: wget --no-verbose --tries=1 --spider http://localhost:8090/info || exit 1
+      interval: 3s
+      timeout: 1s
+      retries: 5
+
+  ddc-storage-node-1:
+    container_name: "ddc-storage-node-1"
+    image: 'cerebellumnetwork/ddc-storage-node:dev-latest'
+    environment:
+      - 'HTTP_PORT=8091'
+      - 'HTTP_ADDRESS=http://localhost:8091'
+      - 'LOG_LEVEL=info'
+      - 'LOG_JSON_FORMAT=false'
+      - 'TEST_ENABLED=true'
+    ports:
+      - '8091:8091'
+    healthcheck:
+      test: wget --no-verbose --tries=1 --spider http://localhost:8091/info || exit 1
+      interval: 3s
+      timeout: 1s
+      retries: 5
+
+  ddc-storage-node-2:
+    container_name: "ddc-storage-node-2"
+    image: 'cerebellumnetwork/ddc-storage-node:dev-latest'
+    environment:
+      - 'HTTP_PORT=8092'
+      - 'HTTP_ADDRESS=http://localhost:8092'
+      - 'LOG_LEVEL=info'
+      - 'LOG_JSON_FORMAT=false'
+      - 'TEST_ENABLED=true'
+    ports:
+      - '8092:8092'
+    healthcheck:
+      test: wget --no-verbose --tries=1 --spider http://localhost:8092/info || exit 1
+      interval: 3s
+      timeout: 1s
+      retries: 5

jest.config.js

@@ -10,8 +10,16 @@ module.exports = {
     "jest.config.js",
     "/node_modules/",
     "/build/",
+    "/dist/"
+  ],
+  testPathIgnorePatterns: [
+    "/node_modules/",
+    "/build/",
+    "/dist/"
   ],
   moduleNameMapper: {
     '^@cere-ddc-sdk/(.*)$': '<rootDir>/packages/$1/'
-  }
+  },
+  globalSetup: "./jest.setup.js",
+  globalTeardown: "./jest.teardown.js",
 };

jest.setup.js

@@ -0,0 +1,14 @@
+const {DockerComposeEnvironment, Wait} = require("testcontainers");
+const {composeFilePath, composeFile} = require("./jest.variables");
+
+module.exports = async function (globalConfig) {
+    console.log(`Start ${composeFilePath}/${composeFile}`);
+    globalThis.__DOCKER_COMPOSE__ = await new DockerComposeEnvironment(composeFilePath, composeFile)
+        .withWaitStrategy("ddc-cdn-node", Wait.forHealthCheck())
+        .withWaitStrategy("ddc-storage-node-0", Wait.forHealthCheck())
+        .withWaitStrategy("ddc-storage-node-1", Wait.forHealthCheck())
+        .withWaitStrategy("ddc-storage-node-2", Wait.forHealthCheck())
+        .up();
+
+    console.log(`Docker-compose is UP`);
+};

jest.teardown.js

@@ -0,0 +1,7 @@
+const {composeFilePath, composeFile} = require("./jest.variables");
+
+module.exports = async function (globalConfig) {
+    console.log(`Stop ${composeFilePath}/${composeFile}`);
+    await globalThis.__DOCKER_COMPOSE__.down();
+    console.log(`Docker-compose is DOWN`);
+};

jest.variables.js

@@ -0,0 +1,4 @@
+const path = require("path");
+
+module.exports.composeFilePath = path.resolve("docker-compose");
+module.exports.composeFile = "docker-compose.yml";