Merge pull request #130 from monax/streaming-error-swallow

Fix JS client swallowing streaming errors

.gitattributes

@@ -0,0 +1,4 @@
+*.pb.go linguist-generated
+*_pb.d.ts linguist-generated
+*_pb.js linguist-generated
+yarn.lock linguist-generated

.github/workflows/main.yaml

@@ -9,6 +9,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - uses: actions/setup-go@v2
         with:
           go-version: 1.15
@@ -26,6 +28,8 @@ jobs:
       GCLOUD_SERVICE_KEY: ${{ secrets.GCLOUD_SERVICE_KEY }}
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - uses: actions/setup-go@v2
         with:
           go-version: 1.15

.github/workflows/release.yaml

@@ -38,11 +38,7 @@ jobs:
         run: |
           git config --global user.email "${GITHUB_ACTOR}"
           git config --global user.name "${GITHUB_ACTOR}"
-          cd js
-          yarn install
-          yarn build
-          yarn version --no-git-tag-version --new-version $(git describe --tags)
-          yarn publish --non-interactive --access public .
+          make publish_js
 
   docker:
     runs-on: ubuntu-latest

.github/workflows/test.yaml

@@ -7,6 +7,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - uses: actions/setup-go@v2
         with:
           go-version: 1.15
@@ -26,6 +28,8 @@ jobs:
       GCLOUD_SERVICE_KEY: ${{ secrets.GCLOUD_SERVICE_KEY }}
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - uses: actions/setup-go@v1
         with:
           go-version: 1.15
@@ -39,4 +43,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       - run: make docker_build

CHANGELOG.md

@@ -1,4 +1,12 @@
 # [Monax Hoard](https://github.com/monax/hoard) Changelog
+## [9.1.0]
+### Fixed
+- [JS] Streaming functions in JS client would swallow all GRPC errors and instead throw on a null exception on getHead for the first frame of messages, now we wait for error message and reject with that message
+
+### Added
+- [JS] Convenience methods for serialising and deserialising grants to base64 so grants can be treated as opaque identifiers
+
+
 ## [9.0.0]
 This is a fairly major release and the client APIs change significantly. However Grant v2s are still supported and the protobuf API is backwards-compatible.
 
@@ -227,6 +235,7 @@ This is the first Hoard open source release and includes:
 	- Hoar-Daemon hoard
 	- Hoar-Control hoarctl CLI
 
+[9.1.0]: https://github.com/monax/hoard/compare/v9.0.0...v9.1.0
 [9.0.0]: https://github.com/monax/hoard/compare/v8.2.3...v9.0.0
 [8.2.3]: https://github.com/monax/hoard/compare/v8.2.2...v8.2.3
 [8.2.2]: https://github.com/monax/hoard/compare/v8.2.1...v8.2.2

Makefile

@@ -153,6 +153,12 @@ docker_build: commit_hash
 build_dist:
 	@goreleaser --rm-dist --skip-publish --skip-validate
 
+.PHONY: publish_js
+publish_js:
+	yarn --cwd js install
+	yarn --cwd js build
+	yarn --cwd js publish --non-interactive --access public --no-git-tag-version --new-version $(shell ./scripts/local_version.sh)
+
 # Testing
 
 .PHONY:	test

NOTES.md

@@ -1,23 +1,6 @@
-This is a fairly major release and the client APIs change significantly. However Grant v2s are still supported and the protobuf API is backwards-compatible.
-
-### Added
-- [Hoard] Grants store the refs to their chunks in a new LINK ref type that is followed during dereferencing (Get, UnsealGet, Decrypt). Version 4 grants _always_ store a single LINK ref. This LINK ref is guaranteed to be unique to the Grant (and therefore grants are now unique). This means UnsealDelete can be safely called without the risk of deleting data still referenced by other grants. This also means grants are not linear in the number of chunks used to store them which keeps grants in constant size.
-- [Hoard] Refs now store the size of the plaintext data stored behind them. This allows for easier random access and predictable downloads.
-- [Hoard] Added regression test to check grant-to-plaintext compatibility between versions.
-
-### Changed
-- [JS] Move to pure-js @grpc/grpc-js library
-- [JS] Expose more usable methods from the client (breaking)
-- [JS] Support streaming versions of calls taking BytesLike
-- [Hoard] Make default storage ChunkSize 3 MiB
-- [Hoard] Body can be sent in same message as MustPlaintext Header (but Header data will be normalised out into first message on storage and retrieval)
-- [Hoard] Grants now encode their references using Protobuf rather than JSON (backwards compatible with grant V2)
-
-
 ### Fixed
-- [Hoard] Blocking read-then-write write-then-read usage
-- [Hoard] Unnecessary copying for streams
-- [Hoard] Encrypt endpoints not chunking
-- [Cloud] Stat now explicitly checks for NotFound error for Exists flag, and throws other errors
+- [JS] Streaming functions in JS client would swallow all GRPC errors and instead throw on a null exception on getHead for the first frame of messages, now we wait for error message and reject with that message
 
+### Added
+- [JS] Convenience methods for serialising and deserialising grants to base64 so grants can be treated as opaque identifiers
 

js/.eslintrc.js

@@ -12,11 +12,21 @@ module.exports = {
   },
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    ecmaVersion: 2018,
+    ecmaVersion: 2020,
     sourceType: 'module',
   },
   plugins: ['@typescript-eslint', 'jest', 'prettier'],
   rules: {
+    'prettier/prettier': [
+      'error',
+      {
+        printWidth: 120,
+        singleQuote: true,
+        useTabs: false,
+        tabWidth: 2,
+        trailingComma: 'all',
+      },
+    ],
     '@typescript-eslint/no-namespace': 'off',
     '@typescript-eslint/camelcase': 0,
     'no-process-env': 'error',

js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monax/hoard",
-  "version": "0.0.0",
+  "version": "9.0.0-dev.5644f38",
   "description": "Hoard client library",
   "main": "dist/index.js",
   "scripts": {
@@ -37,27 +37,26 @@
   },
   "homepage": "https://github.com/monax/hoard#readme",
   "dependencies": {
-    "@grpc/grpc-js": "^1.2.2",
-    "@types/google-protobuf": "^3.7.4",
-    "google-protobuf": "^3.14.0",
-    "openpgp": "^4.10.8"
+    "@grpc/grpc-js": "^1.3.2",
+    "@types/google-protobuf": "^3.15.2",
+    "google-protobuf": "^3.17.2",
+    "openpgp": "4.10.10"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.15",
-    "@types/openpgp": "^4.4.14",
-    "@typescript-eslint/eslint-plugin": "^4.7.0",
-    "@typescript-eslint/parser": "^4.7.0",
+    "@types/jest": "^26.0.23",
+    "@types/openpgp": "^4.4.16",
+    "@typescript-eslint/eslint-plugin": "^4.26.0",
+    "@typescript-eslint/parser": "^4.26.0",
     "eslint": "^7.13.0",
     "eslint-plugin-jest": "^24.1.3",
     "eslint-plugin-prettier": "^3.1.4",
-    "grpc-tools": "^1.10.0",
-    "grpc_tools_node_protoc_ts": "^5.0.1",
-    "jest": "^26.6.3",
+    "grpc-tools": "^1.11.1",
+    "grpc_tools_node_protoc_ts": "^5.2.2",
+    "jest": "^27.0.4",
     "prettier": "^2.1.2",
-    "prettier-plugin-organize-imports": "^1.1.1",
-    "source-map-support": "^0.5.19",
-    "ts-jest": "^26.4.4",
-    "ts-node": "^9.0.0",
-    "typescript": "^4.1.2"
+    "prettier-plugin-organize-imports": "^2.1.0",
+    "ts-jest": "^27.0.2",
+    "ts-node": "^10.0.0",
+    "typescript": "^4.3.2"
   }
 }