#2287 Add example scripts showing pub/sub usage. #2288

con-mark · 2022-10-05T21:32:20Z

Description

Added example requested for Issue #2287

created pubsub-publisher.js and pubsub-subscriber.js

Checklist

Does npm test pass with this change (including linting)?
Is the new or changed code fully tested?
Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?

#2287

SuzeShardlow · 2022-10-06T09:40:21Z

Closes #2287 when approved and merged.

simonprickett

Hi there - when I run pubsub-subscriber.js node-redis errors because the client isn't connected... I thjink you need to add await client.connect(); in there to connect to Redis before trying any Redis commands.

I would also suggest having the publisher console log what it's doing, and finally please ensure that the table of example scripts in README has its formatting maintained so that the | lines up.

These are just minor things - nice work and we look forward to merging.

SuzeShardlow · 2022-10-06T18:09:40Z

@con-mark thanks for your PR - not sure if you have seen @simonprickett's comments above, but he is asking for a couple of changes before we merge this. Thanks!

Fixing comments requested Adding client.connect() to pubsub-subscriber.js Reformatting Readme updating logging in pubsub-publisher.js

con-mark · 2022-10-06T21:22:24Z

Hi @simonprickett @SuzeShardlow I have made requested changes please let me know if any further changes are needed.

SuzeShardlow · 2022-10-06T22:17:49Z

Thanks @con-mark, we will take a look in our morning! :)

simonprickett

I've left some tidy up commit suggestions, but am also unable to get the example to work, the publisher publishes messages but the subscriber never outputs anything...

simonprickett · 2022-10-07T16:09:58Z

examples/pubsub-publisher.js

+for (let i = 0; i < 10000; i++) {
+  //1st channel created to publish 10000 messages
+  await client.publish(channel1, `channel1_message_${i}`);
+  console.log(`publising message on ${channel1}`);


Suggested change

console.log(`publising message on ${channel1}`);

console.log(`publishing message on ${channel1}`);

simonprickett · 2022-10-07T16:10:09Z

examples/pubsub-publisher.js

+  console.log(`publising message on ${channel1}`);
+  //2nd channel created to publish 10000 messages
+  await client.publish(channel2, `channel2_message_${i}`);
+  console.log(`publising message on ${channel2}`);


Suggested change

console.log(`publising message on ${channel2}`);

console.log(`publishing message on ${channel2}`);

simonprickett · 2022-10-07T16:10:26Z

examples/pubsub-publisher.js

+
+await client.connect();
+
+//declare constant variables for the name of the clients we will publish to as they will be required for logging


Suggested change

//declare constant variables for the name of the clients we will publish to as they will be required for logging

// Declare constant variables for the name of the clients we will publish to as they will be required for logging.

simonprickett · 2022-10-07T16:10:39Z

examples/pubsub-publisher.js

+const channel2 = 'chan2nel';
+
+for (let i = 0; i < 10000; i++) {
+  //1st channel created to publish 10000 messages


Suggested change

//1st channel created to publish 10000 messages

// 1st channel created to publish 10000 messages.

simonprickett · 2022-10-07T16:11:06Z

examples/pubsub-publisher.js

+  //1st channel created to publish 10000 messages
+  await client.publish(channel1, `channel1_message_${i}`);
+  console.log(`publising message on ${channel1}`);
+  //2nd channel created to publish 10000 messages


Suggested change

//2nd channel created to publish 10000 messages

// 2nd channel created to publish 10000 messages.

simonprickett · 2022-10-07T16:11:48Z

examples/pubsub-subscriber.js

+const client = createClient();
+await client.connect();
+
+//Each subscriber needs to connect individually therefore we duplicate the client.


Suggested change

//Each subscriber needs to connect individually therefore we duplicate the client.

// Each subscriber needs to connect individually therefore we duplicate the client.

simonprickett · 2022-10-07T16:11:59Z

examples/pubsub-subscriber.js

+await noChannelsSub.connect();
+await allChannelsSub.connect();
+
+//This subscriber only will receive messages from channel 1 as they are using the subscribe method and subscribed to chan1nel


Suggested change

//This subscriber only will receive messages from channel 1 as they are using the subscribe method and subscribed to chan1nel

// This subscriber only will receive messages from channel 1 as they are using the subscribe method and subscribed to chan1nel.

simonprickett · 2022-10-07T16:12:10Z

examples/pubsub-subscriber.js

+  console.log(`Channel1 subscriber collected message: ${message}`);
+},true);
+
+//This subscriber only will receive messages from channel 2 as they are using the subscribe method and subscribed to chan2nel


Suggested change

//This subscriber only will receive messages from channel 2 as they are using the subscribe method and subscribed to chan2nel

// This subscriber only will receive messages from channel 2 as they are using the subscribe method and subscribed to chan2nel.

simonprickett · 2022-10-07T16:12:22Z

examples/pubsub-subscriber.js

+  console.log(`Channel2 subscriber collected message: ${message}`);
+},true);
+
+//This subscriber receive messages from both channel 1 and channel 2 thanks the pSubscribe method.


Suggested change

//This subscriber receive messages from both channel 1 and channel 2 thanks the pSubscribe method.

// This subscriber receive messages from both channel 1 and channel 2 using the pSubscribe method.

simonprickett · 2022-10-07T16:12:39Z

examples/pubsub-subscriber.js

+  console.log(`Channel ${channel} sent message: ${message}`);
+},true);
+
+//clean up after ourselves by unsubsribing


Suggested change

//clean up after ourselves by unsubsribing

// Clean up after ourselves by unsubscribing.

removed clean up

SuzeShardlow · 2022-10-07T21:08:28Z

@con-mark, please see the above comments from @simonprickett and let us know if you can make the changes - the subscriber in your example isn't outputting anything for us. Thanks!

Fix publish and subscriber Update tidy up comments

con-mark · 2022-10-08T17:16:19Z

Hi @SuzeShardlow and @simonprickett I have made the tidy up comments and I have fixed the issue with the subscriber seems like doing the clean up and closing the client before they got a chance to interact with the Redis to publish or subscribe.

Please let me know if you need anything more.

I also may suggest some other improvement for your hacktoberfest contribution might be for someone to create a docker compose that will allow the the running of the examples with a redis image for people to not have to worry for set up :)

simonprickett

@con-mark thanks - left one tiny suggestion and this should then be good to go.

examples/pubsub-subscriber.js

Making suggested changes Co-authored-by: Simon Prickett <simon@crudworks.org>

con-mark · 2022-10-13T19:51:37Z

Hi @SuzeShardlow @simonprickett is any further changes needed here? Please let me know :)

codecov-commenter · 2022-10-14T21:57:21Z

Codecov Report

Base: 95.85% // Head: 95.85% // No change to project coverage 👍

Coverage data is based on head (27bbbb4) compared to base (2a8e11a).
Patch has no changes to coverable lines.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2288   +/-   ##
=======================================
  Coverage   95.85%   95.85%           
=======================================
  Files         433      433           
  Lines        4002     4002           
  Branches      451      451           
=======================================
  Hits         3836     3836           
  Misses        102      102           
  Partials       64       64

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

SuzeShardlow · 2022-10-14T22:08:28Z

@con-mark thanks for your contribution! If you are a member of our Discord server, please let us know your handle so we can give you the Hacktoberfest 2022 role. Thanks!

con-mark · 2022-10-16T14:25:38Z

Hi @SuzeShardlow my discord is dev-mark#1608

SuzeShardlow · 2022-10-16T15:16:41Z

Thanks @con-mark, I've given you the role in Discord :)

#2287 Add example scripts showing pub/sub usage.

Verified

This commit was signed with the committer’s verified signature.

connor4312 Connor Peet

GPG key ID: CF8FD2EA0DBC61BD

Verified
Learn about vigilant mode

d29d5bf

#2287

SuzeShardlow requested a review from simonprickett October 6, 2022 09:40

simonprickett suggested changes Oct 6, 2022

View reviewed changes

#2287 Add example scripts showing pub/sub usage.

f01acaf

Fixing comments requested Adding client.connect() to pubsub-subscriber.js Reformatting Readme updating logging in pubsub-publisher.js

SuzeShardlow requested review from simonprickett and SuzeShardlow October 6, 2022 22:17

simonprickett suggested changes Oct 7, 2022

View reviewed changes

#2287 Add example scripts showing pub/sub usage.

aa7541b

Fix publish and subscriber Update tidy up comments

SuzeShardlow requested a review from simonprickett October 8, 2022 18:49

simonprickett suggested changes Oct 11, 2022

View reviewed changes

examples/pubsub-subscriber.js Outdated Show resolved Hide resolved

Update examples/pubsub-subscriber.js

27bbbb4

Making suggested changes Co-authored-by: Simon Prickett <simon@crudworks.org>

SuzeShardlow requested a review from simonprickett October 13, 2022 21:32

simonprickett approved these changes Oct 14, 2022

View reviewed changes

SuzeShardlow merged commit d0bfa77 into redis:master Oct 14, 2022

SuzeShardlow added the hacktoberfest-accepted label Oct 14, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#2287 Add example scripts showing pub/sub usage. #2288

#2287 Add example scripts showing pub/sub usage. #2288

con-mark commented Oct 5, 2022

SuzeShardlow commented Oct 6, 2022

simonprickett left a comment

SuzeShardlow commented Oct 6, 2022

con-mark commented Oct 6, 2022

SuzeShardlow commented Oct 6, 2022

simonprickett left a comment

simonprickett Oct 7, 2022

con-mark Oct 10, 2022

simonprickett Oct 7, 2022

con-mark Oct 10, 2022

simonprickett Oct 7, 2022

con-mark Oct 10, 2022

simonprickett Oct 7, 2022

con-mark Oct 10, 2022

simonprickett Oct 7, 2022

con-mark Oct 10, 2022

simonprickett Oct 7, 2022

con-mark Oct 10, 2022

simonprickett Oct 7, 2022

con-mark Oct 10, 2022

simonprickett Oct 7, 2022

con-mark Oct 10, 2022

simonprickett Oct 7, 2022

con-mark Oct 10, 2022

simonprickett Oct 7, 2022

con-mark Oct 10, 2022

SuzeShardlow commented Oct 7, 2022

con-mark commented Oct 8, 2022

simonprickett left a comment

con-mark commented Oct 13, 2022

codecov-commenter commented Oct 14, 2022

SuzeShardlow commented Oct 14, 2022

con-mark commented Oct 16, 2022

SuzeShardlow commented Oct 16, 2022

	console.log(`publising message on ${channel1}`);
	console.log(`publishing message on ${channel1}`);


		await client.connect();

		//declare constant variables for the name of the clients we will publish to as they will be required for logging

	//declare constant variables for the name of the clients we will publish to as they will be required for logging
	// Declare constant variables for the name of the clients we will publish to as they will be required for logging.

	//1st channel created to publish 10000 messages
	// 1st channel created to publish 10000 messages.

	//2nd channel created to publish 10000 messages
	// 2nd channel created to publish 10000 messages.

	//Each subscriber needs to connect individually therefore we duplicate the client.
	// Each subscriber needs to connect individually therefore we duplicate the client.

	//This subscriber only will receive messages from channel 1 as they are using the subscribe method and subscribed to chan1nel
	// This subscriber only will receive messages from channel 1 as they are using the subscribe method and subscribed to chan1nel.

	//This subscriber receive messages from both channel 1 and channel 2 thanks the pSubscribe method.
	// This subscriber receive messages from both channel 1 and channel 2 using the pSubscribe method.

	//clean up after ourselves by unsubsribing
	// Clean up after ourselves by unsubscribing.

#2287 Add example scripts showing pub/sub usage. #2288

#2287 Add example scripts showing pub/sub usage. #2288

Conversation

con-mark commented Oct 5, 2022

Description

Checklist

SuzeShardlow commented Oct 6, 2022

simonprickett left a comment

Choose a reason for hiding this comment

SuzeShardlow commented Oct 6, 2022

con-mark commented Oct 6, 2022

SuzeShardlow commented Oct 6, 2022

simonprickett left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SuzeShardlow commented Oct 7, 2022

con-mark commented Oct 8, 2022

simonprickett left a comment

Choose a reason for hiding this comment

con-mark commented Oct 13, 2022

codecov-commenter commented Oct 14, 2022

Codecov Report

SuzeShardlow commented Oct 14, 2022

con-mark commented Oct 16, 2022

SuzeShardlow commented Oct 16, 2022