ts-proto 1.90.1 → 1.91.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [1.91.0](https://github.com/stephenh/ts-proto/compare/v1.90.1...v1.91.0) (2021-11-27)
+
+
+### Bug Fixes
+
+* use Long.fromValue instead of Long.fromString for improved robustness regarding already parsed objects ([#405](https://github.com/stephenh/ts-proto/issues/405)) ([7bdc3ee](https://github.com/stephenh/ts-proto/commit/7bdc3eee05ed1318e18e27aa7d5bb2680060f8b6))
+
+
+### Features
+
+* Include dockerized protoc ([#404](https://github.com/stephenh/ts-proto/issues/404)) ([7564a78](https://github.com/stephenh/ts-proto/commit/7564a7887ccd0bb80cac19d313ee9bd8daae778d))
+
 ## [1.90.1](https://github.com/stephenh/ts-proto/compare/v1.90.0...v1.90.1) (2021-11-27)
 
 

package/README.markdown

@@ -18,7 +18,7 @@
   - [Supported options](#supported-options)
   - [Only Types](#only-types)
   - [NestJS Support](NESTJS.markdown)
-- [Building](#building)
+- [Development](#development)
 - [Assumptions](#assumptions)
 - [Todo](#todo)
 - [OneOf Handling](#oneof-handling)
@@ -362,15 +362,69 @@ Kudos to our sponsors:
 
 If you need ts-proto customizations or priority support for your company, you can ping me at [via email](mailto:stephen.haberman@gmail.com).
 
-# Building
+# Development
 
-After running `yarn install`, run `./integration/pbjs.sh` to create the integration test types. These pbjs-generated files are not currently checked in.
+**Requirements**
 
-After this, the tests should pass.
+- [Docker](https://www.docker.com) or [protoc](https://github.com/protocolbuffers/protobuf/releases) v3.19.1
+- `yarn` — `npm install -g yarn`
 
-After making changes to `ts-proto`, you can run `cd integration` and `./codegen.sh` to re-generate the test case `*.ts` output files that are in each `integration/<test-case>/` directory.
+**Setup**
 
-The test suite's proto files (i.e. `simple.proto`, `batching.proto`, etc.) currently have serialized/`.bin` copies checked into git (i.e. `simple.bin`, `batching.bin`, etc.), so that the test suite can run without having to invoke the `protoc` build chain. I.e. if you change the `simple.proto`/etc. files, you'll need to run `./integration/update-bins.sh`, which does require having the `protoc` executable available.
+The commands below assume you have **Docker** installed. To use a **local** copy of `protoc` without docker, use commands suffixed with `:local`
+
+- Check out the [repository]() for the latest code.
+- Run `yarn install` to install the dependencies.
+- Run `yarn build:test` or `yarn build:test:local` to generate the test files.
+  > _This runs the following commands:_
+  >  - `proto2bin` — Converts integration test `.proto` files to `.bin`.
+  >  - `bin2ts` — Runs `ts-proto` on the `.bin` files to generate  `.ts`  files.
+  >  - `proto2pbjs` — Generates a reference implementation using `pbjs` for testing compatibility.
+- Run `yarn test`
+
+**Workflow**
+
+- Modifying the plugin implementation:
+  - Run `yarn bin2ts` or `yarn bin2ts:local`.  
+    _Since the proto files were not changed, you only need to regenerate the typescript files._
+  - Run `yarn test` to verify the typescript files are compatible with the reference implementation, and pass other tests.
+- Updating or adding `.proto` files in the integration directory:
+  - Run `yarn build:test` to regenerate the integration test files.
+  - Run `yarn test` to retest.
+
+**Contributing**
+
+- Run `yarn build:test` and `yarn test` to make sure everything works.
+- Run `yarn prettier` to format the typescript files.
+- Commit the changes:
+  - Also include the generated `.bin` files for the tests where you added or modified `.proto` files.  
+    > These are checked into git so that the test suite can run without having to invoke the `protoc` build chain.
+  - Also include the generated `.ts` files.
+- Create a pull request
+
+**Dockerized Protoc**
+
+The repository includes a dockerized version of `protoc`, which is configured in [docker-compose.yml](docker-compose.yml).
+
+It can be useful in case you want to manually invoke the plugin with a known version of `protoc`.
+
+Usage:
+
+```bash
+# Include the protoc alias in your shell.
+. aliases.sh
+
+# Run protoc as usual. The ts-proto directory is available in /ts-proto.
+protoc --plugin=/ts-proto/protoc-gen-ts_proto --ts_proto_out=./output -I=./protos ./protoc/*.proto
+
+# Or use the ts-protoc alias which specifies the plugin path for you.
+ts-protoc --ts_proto_out=./output -I=./protos ./protoc/*.proto
+```
+
+- All paths must be relative paths _within_ the current working directory of the host. `../` is not allowed
+- Within the docker container, the absolute path to the project root is `/ts-proto`
+- The container mounts the current working directory in `/host`, and sets it as its working directory.
+- Once `aliases.sh` is sourced, you can use the `protoc` command in any folder.
 
 # Assumptions
 

package/build/main.js

@@ -823,7 +823,7 @@ function generateFromJson(ctx, fullName, messageDesc) {
                             }
                         }
                         else if (types_1.isLong(valueType) && options.forceLong === options_1.LongOption.LONG) {
-                            return ts_poet_1.code `Long.fromString(${from} as string)`;
+                            return ts_poet_1.code `Long.fromValue(${from} as Long | string)`;
                         }
                         else if (types_1.isEnum(valueType)) {
                             return ts_poet_1.code `${from} as number`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-proto",
-  "version": "1.90.1",
+  "version": "1.91.0",
   "description": "",
   "main": "build/plugin.js",
   "repository": "github:stephenh/ts-proto",
@@ -9,10 +9,19 @@
   },
   "scripts": {
     "build": "yarn tsc",
-    "setup": "cd ./integration && ./pbjs.sh && ./update-bins.sh && ./codegen.sh",
+    "build:test": "yarn proto2bin && yarn proto2pbjs && yarn bin2ts",
+    "build:test:local": "yarn proto2bin:local && yarn proto2pbjs:local && yarn bin2ts:local",
+    "proto2bin": "docker-compose run --rm protoc update-bins.sh",
+    "proto2bin-node": "docker-compose run --rm node update-bins.sh",
+    "proto2pbjs": "docker-compose run --rm protoc pbjs.sh",
+    "bin2ts": "docker-compose run --rm protoc codegen.sh",
+    "proto2bin:local": "integration/update-bins.sh",
+    "proto2pbjs:local": "integration/pbjs.sh",
+    "bin2ts:local": "integration/codegen.sh",
     "test": "yarn jest -c jest.config.js --maxWorkers=2",
     "prettier": "prettier --write {src,tests}/**/*.ts",
-    "prettier:check": "prettier --list-different {src,tests}/**/*.ts"
+    "prettier:check": "prettier --list-different {src,tests}/**/*.ts",
+    "setup:docker": "docker-compose build"
   },
   "files": [
     "build"