Skip to content

Fix Configuration GRPC calls not sending metadata #571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 12, 2024
Merged

Fix Configuration GRPC calls not sending metadata #571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
319564c
Fix Configuration GRPC calls not sending metadata
tlund101 Feb 9, 2024
2d0faf8
Address PR comment
tlund101 Feb 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 5 additions & 20 deletions src/implementation/Client/GRPCClient/configuration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ limitations under the License.
*/

import GRPCClient from "./GRPCClient";
import * as grpc from "@grpc/grpc-js";
import {
GetConfigurationRequest,
GetConfigurationResponse,
Expand All @@ -28,7 +27,7 @@ import { SubscribeConfigurationResponse as SubscribeConfigurationResponseResult
import { SubscribeConfigurationCallback } from "../../../types/configuration/SubscribeConfigurationCallback";
import { SubscribeConfigurationStream } from "../../../types/configuration/SubscribeConfigurationStream";
import { ConfigurationItem } from "../../../types/configuration/ConfigurationItem";
import { createConfigurationType } from "../../../utils/Client.util";
import { addMetadataToMap, createConfigurationType } from "../../../utils/Client.util";

export default class GRPCClientConfiguration implements IClientConfiguration {
client: GRPCClient;
Expand All @@ -38,25 +37,18 @@ export default class GRPCClientConfiguration implements IClientConfiguration {
}

async get(storeName: string, keys: string[], metadataObj?: KeyValueType): Promise<GetConfigurationResponseResult> {
const metadata = new grpc.Metadata();

const msg = new GetConfigurationRequest();
msg.setStoreName(storeName);

if (keys && keys.length > 0) {
msg.setKeysList(keys.filter((i) => i !== ""));
}

if (metadataObj) {
for (const [key, value] of Object.entries(metadataObj)) {
metadata.add(key, value);
}
}
addMetadataToMap(msg.getMetadataMap(), metadataObj);

const client = await this.client.getClient();

return new Promise((resolve, reject) => {
client.getConfiguration(msg, metadata, (err, res: GetConfigurationResponse) => {
client.getConfiguration(msg, (err, res: GetConfigurationResponse) => {
if (err) {
return reject(err);
}
Expand Down Expand Up @@ -99,8 +91,6 @@ export default class GRPCClientConfiguration implements IClientConfiguration {
keys?: string[],
metadataObj?: KeyValueType,
): Promise<SubscribeConfigurationStream> {
const metadata = new grpc.Metadata();

const msg = new SubscribeConfigurationRequest();
msg.setStoreName(storeName);

Expand All @@ -109,20 +99,15 @@ export default class GRPCClientConfiguration implements IClientConfiguration {
} else {
msg.setKeysList([]);
}

if (metadataObj) {
for (const [key, value] of Object.entries(metadataObj)) {
metadata.add(key, value);
}
}
addMetadataToMap(msg.getMetadataMap(), metadataObj);

const client = await this.client.getClient();

// Open a stream. Note that this is a never-ending stream
// and will stay open as long as the client is open
// we will thus create a set with our listeners so we don't
// break on multi listeners
const stream = client.subscribeConfiguration(msg, metadata);
const stream = client.subscribeConfiguration(msg);
let streamId: string;

stream.on("data", async (data: SubscribeConfigurationResponse) => {
Expand Down
7 changes: 2 additions & 5 deletions test/e2e/grpc/client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,14 +363,11 @@ describe("grpc/client", () => {
});

it("should be able to get the configuration items with metadata", async () => {
await client.configuration.get("config-redis", ["myconfigkey1"], {
const conf = await client.configuration.get("config-redis", ["myconfigkey1"], {
hello: "world",
});

// Disabled for now as I am unsure if Dapr returns the metadata items
// Java SDK: https://github.com/dapr/java-sdk/blob/06d92dafca62a6b48e74ccf939feeac7189e360f/sdk/src/test/java/io/dapr/client/DaprPreviewClientGrpcTest.java#L119
// ^ shows that it is not being tested, it tries but doesn't assert
// expect(conf.items.filter(i => i.key == "myconfigkey1")[0].metadata).toHaveProperty("hello");
expect(conf.items["myconfigkey1"].metadata).toHaveProperty("hello");
});

it("should be able to subscribe to configuration item changes on all keys", async () => {
Expand Down