docs: Add warning message to dapr-client builds (#313)

* Add warning message on using dapr-client

Signed-off-by: Shubham Sharma <[email protected]>

* Fix script

Signed-off-by: Shubham Sharma <[email protected]>

* Update build step

Signed-off-by: Shubham Sharma <[email protected]>

* Typecast to prevent TS2367

Signed-off-by: Shubham Sharma <[email protected]>

* Check-in version file to version control

Signed-off-by: Shubham Sharma <[email protected]>

* Remove unused linter comment

Signed-off-by: Shubham Sharma <[email protected]>

* Do not track version file

Signed-off-by: Shubham Sharma <[email protected]>

* Updates

Signed-off-by: Shubham Sharma <[email protected]>

Author: shubham1172

.github/workflows/build.yml

@@ -43,7 +43,7 @@ jobs:
         registry-url: 'https://registry.npmjs.org'
 
     - name: Build Package
-      run: ./scripts/build.sh
+      run: npm run build
 
     # @TODO: add a depend on the test-e2e pipeline?
     - name: Run unit tests
@@ -70,7 +70,7 @@ jobs:
 
     - name: "[dapr-client] Build Package"
       if: env.DEPLOY_PACKAGE == 'true'
-      run: ./scripts/build.sh
+      run: npm run build
 
     # note: package.json gets updated here for the new package name
     - name: "[dapr-client] Publish to npm (dapr-client)"

.github/workflows/test-e2e.yml

@@ -121,8 +121,8 @@ jobs:
         node-version: ${{ env.NODE_VER }}
         registry-url: 'https://registry.npmjs.org'
 
-    - name: Install NPM Dependencies
-      run: npm i
+    - name: Build Package
+      run: npm run build
 
     - name: Run E2E tests
       id: tests

.gitignore

@@ -141,4 +141,7 @@ tmp/
 temp/
 
 # dapr-js-sdk
-build/
+build/
+
+# version file is auto-generated
+src/version.ts

package.json

@@ -19,6 +19,7 @@
         "test:unit:logger": "NODE_ENV=test npm run test:unit 'test/unit/logger/.*\\.test\\.ts'",
         "test:unit:utils": "NODE_ENV=test npm run test:unit 'test/unit/utils/.*\\.test\\.ts'",
         "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+        "prebuild": "./scripts/prebuild.sh",
         "build": "./scripts/build.sh",
         "start:dev": "npm run build && nodemon --ext \".ts,.js\" --watch \"./src\" --exec \"npm run build\""
     },

scripts/prebuild.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+#
+# Copyright 2022 The Dapr Authors
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#     http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This script generates a typescript file with constants 
+# for the SDK version and the SDK package name.
+
+FILENAME="src/version.ts"
+HEADER="/*
+Copyright 2022 The Dapr Authors
+Licensed under the Apache License, Version 2.0 (the \"License\");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an \"AS IS\" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// This file is auto-generated by the prebuild script from package.json.
+// It is not checked in to the git repository.
+
+"
+
+echo "$HEADER" > $FILENAME
+
+node -p "'export const SDK_VERSION = ' + JSON.stringify(require('./package.json').version) + ';\n\
+export const SDK_PACKAGE_NAME = ' + JSON.stringify(require('./package.json').name) + ';'" >> $FILENAME

src/implementation/Client/DaprClient.ts

@@ -56,6 +56,7 @@ import { DaprClientOptions } from '../../types/DaprClientOptions';
 import { Settings } from '../../utils/Settings.util';
 import { Logger } from '../../logger/Logger';
 import GRPCClientProxy from "./GRPCClient/proxy";
+import { SDK_PACKAGE_NAME } from "../../version";
 
 export default class DaprClient {
   readonly daprHost: string;
@@ -95,6 +96,10 @@ export default class DaprClient {
       throw new Error('DAPR_INCORRECT_SIDECAR_PORT');
     }
 
+    if (String(SDK_PACKAGE_NAME) === "dapr-client") {
+      this.logger.warn("dapr-client is deprecated. Please use @dapr/dapr instead. For more information, see https://github.com/dapr/js-sdk/issues/259")
+    }
+
     // Builder
     switch (communicationProtocol) {
       case CommunicationProtocolEnum.GRPC: {