Skip to content

Commit 4cff428

Browse files
committed
Added Invocation and PubSub examples
1 parent 8613b49 commit 4cff428

File tree

10 files changed

+3019
-0
lines changed

10 files changed

+3019
-0
lines changed

examples/invocation/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Examples - Invocation
2+
3+
This example demonstrates how to use the Invocation API.
4+
5+
## Run
6+
7+
```bash
8+
# If it is not already, initialize DAPR on the system
9+
dapr init
10+
11+
# Install dependenies
12+
npm install
13+
14+
# Run the example
15+
npm run start:dapr-http
16+
```
17+
18+
## Switching to gRPC
19+
20+
By default the example will run using HTTP. To use gRPC, do the following:
21+
* Replace both occurences of `process.env.DAPR_HTTP_PORT` with `process.env.DAPR_GRPC_PORT`
22+
* Replace both occurences of `CommunicationProtocolEnum.HTTP` with `CommunicationProtocolEnum.GRPC`
23+
* Instead of `npm run start:dapr-http` run `npm run start:dapr-grpc`

examples/invocation/package.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"name": "dapr-example-invocation",
3+
"version": "1.0.0",
4+
"description": "An example utilizing the Dapr JS SDK to invoke a service",
5+
"main": "dist/index.js",
6+
"private": true,
7+
"scripts": {
8+
"build": "rimraf ./dist && tsc",
9+
"start": "npm run build && node dist/index.js",
10+
"start:dev": "npm run build && nodemon --ext \".ts,.js\" --watch \"./src\" --exec \"ts-node ./src/index.ts\"",
11+
"start:dapr-grpc": "dapr run --app-id example-invocation --app-port 50051 --app-protocol grpc npm run start",
12+
"start:dapr-http": "dapr run --app-id example-invocation --app-port 50051 --app-protocol http npm run start"
13+
},
14+
"keywords": [],
15+
"license": "ISC",
16+
"devDependencies": {
17+
"nodemon": "^2.0.7",
18+
"rimraf": "^3.0.2",
19+
"ts-node": "^9.1.1",
20+
"typescript": "^4.2.4"
21+
},
22+
"dependencies": {
23+
"dapr-client": "file:../../build",
24+
"@types/node": "^15.3.0",
25+
"google-protobuf": "^3.17.0"
26+
}
27+
}

examples/invocation/src/index.ts

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
import { DaprServer, DaprClient, HttpMethod, CommunicationProtocolEnum } from "dapr-client";
2+
3+
// Common settings
4+
const daprAppId = "example-invocation";
5+
const serverHost = "127.0.0.1"; // App Host of this Example Server
6+
const daprHost = "127.0.0.1";
7+
const serverPort = "50051"; // App Port of this Example Server
8+
9+
async function start() {
10+
// Note that the DAPR_HTTP_PORT and DAPR_GRPC_PORT environment variables are set by DAPR itself. https://docs.dapr.io/reference/environment/
11+
const server = new DaprServer(
12+
serverHost,
13+
serverPort,
14+
daprHost,
15+
process.env.DAPR_HTTP_PORT,
16+
CommunicationProtocolEnum.HTTP
17+
);
18+
19+
const client = new DaprClient(
20+
daprHost,
21+
process.env.DAPR_HTTP_PORT as string,
22+
CommunicationProtocolEnum.HTTP
23+
);
24+
25+
await server.startServer();
26+
27+
console.log("Setting up invocation endpoints")
28+
await server.invoker.listen("hello-world", async (data: any) => {
29+
console.log(`Received: ${JSON.stringify(data.body)} on POST hello-world`);
30+
return { hello: "world received from POST" };
31+
}, { method: HttpMethod.POST });
32+
33+
await server.invoker.listen("hello-world", async () => {
34+
console.log("Received on GET hello-world");
35+
return { hello: "world received from GET" };
36+
}, { method: HttpMethod.GET });
37+
38+
console.log("Invoking endpoints")
39+
const r = await client.invoker.invoke(daprAppId, "hello-world", HttpMethod.POST, {
40+
hello: "world"
41+
});
42+
console.log(`Response to POST request: ${JSON.stringify(r)}`);
43+
const r2 = await client.invoker.invoke(daprAppId, "hello-world", HttpMethod.GET);
44+
console.log(`Response to GET request: ${JSON.stringify(r2)}`);
45+
}
46+
47+
start().catch((e) => {
48+
console.error(e);
49+
process.exit(1);
50+
});

examples/invocation/tsconfig.json

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig.json to read more about this file */
4+
5+
/* Basic Options */
6+
// "incremental": true, /* Enable incremental compilation */
7+
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
8+
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
9+
// "lib": [], /* Specify library files to be included in the compilation. */
10+
// "allowJs": true, /* Allow javascript files to be compiled. */
11+
// "checkJs": true, /* Report errors in .js files. */
12+
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
13+
// "declaration": true, /* Generates corresponding '.d.ts' file. */
14+
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
15+
// "sourceMap": true, /* Generates corresponding '.map' file. */
16+
// "outFile": "./", /* Concatenate and emit output to single file. */
17+
"outDir": "./dist", /* Redirect output structure to the directory. */
18+
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
19+
// "composite": true, /* Enable project compilation */
20+
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
21+
// "removeComments": true, /* Do not emit comments to output. */
22+
// "noEmit": true, /* Do not emit outputs. */
23+
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
24+
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
25+
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
26+
27+
/* Strict Type-Checking Options */
28+
"strict": true, /* Enable all strict type-checking options. */
29+
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
30+
// "strictNullChecks": true, /* Enable strict null checks. */
31+
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
32+
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
33+
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
34+
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
35+
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
36+
37+
/* Additional Checks */
38+
// "noUnusedLocals": true, /* Report errors on unused locals. */
39+
// "noUnusedParameters": true, /* Report errors on unused parameters. */
40+
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
41+
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
42+
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
43+
// "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */
44+
45+
/* Module Resolution Options */
46+
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
47+
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
48+
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
49+
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
50+
// "typeRoots": [], /* List of folders to include type definitions from. */
51+
// "types": [], /* Type declaration files to be included in compilation. */
52+
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
53+
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
54+
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
55+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
56+
57+
/* Source Map Options */
58+
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
59+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
60+
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
61+
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
62+
63+
/* Experimental Options */
64+
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
65+
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
66+
67+
/* Advanced Options */
68+
"skipLibCheck": true, /* Skip type checking of declaration files. */
69+
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
70+
}
71+
}

examples/pubsub/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Examples - PubSubs
2+
3+
This example demonstrates how to use the PubSub API.
4+
5+
## Run
6+
7+
```bash
8+
# If it is not already, initialize DAPR on the system
9+
dapr init
10+
11+
# Install dependenies
12+
npm install
13+
14+
# Start a RabbitMQ Container (for the binding example part)
15+
# note: mgmt interface at http://localhost:15672
16+
docker run -d --rm --hostname my-rabbitmq --name my-rabbitmq \
17+
-e RABBITMQ_DEFAULT_USER=test-user -e RABBITMQ_DEFAULT_PASS=test-password \
18+
-p 0.0.0.0:5672:5672 -p 0.0.0.0:15672:15672 \
19+
rabbitmq:3-management
20+
21+
# Run the example
22+
npm run start:dapr-http
23+
```
24+
25+
## Switching to gRPC
26+
27+
By default the example will run using HTTP. To use gRPC, do the following:
28+
* Replace both occurences of `process.env.DAPR_HTTP_PORT` with `process.env.DAPR_GRPC_PORT`
29+
* Replace both occurences of `CommunicationProtocolEnum.HTTP` with `CommunicationProtocolEnum.GRPC`
30+
* Instead of `npm run start:dapr-http` run `npm run start:dapr-grpc`
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
apiVersion: dapr.io/v1alpha1
2+
kind: Component
3+
metadata:
4+
name: my-pubsub-component
5+
namespace: default
6+
spec:
7+
type: pubsub.rabbitmq
8+
version: v1
9+
metadata:
10+
- name: host
11+
value: "amqp://test-user:test-password@localhost:5672"

0 commit comments

Comments
 (0)