Add warning for the length of the group name by IronJam11 · Pull Request #2122 · django/channels

IronJam11 · 2025-01-10T14:38:07Z

Resolves #1845
Corresponding screenshot :-

carltongibson

Hi @IronJam11. Thanks for this. Needs a regression test, demonstrating the fix.

carltongibson · 2025-01-10T14:45:39Z

channels/layers.py

        raise NotImplementedError("flush() not implemented (flush extension)")

    async def group_add(self, group, channel):
+        print("Hello")


This (and others) need removing.

IronJam11 · 2025-01-11T13:05:16Z

I will work on it. thank you for your review. if you could elaborate on regression test it will be helpful for me as I am a bit new to this org

carltongibson · 2025-01-11T13:28:04Z

Look at the existing test suite for examples, I'd suggest.

https://channels.readthedocs.io/en/latest/contributing.html#how-do-i-get-started-and-run-the-tests

IronJam11 · 2025-01-11T14:51:36Z

I have successfully tested it on my local, there are issues with the tests. :) And I removed all the unnecessary statements as well

IronJam11 · 2025-01-11T16:14:14Z

Correct me if I am wrong, so i ran pytest (all tests passed with 2 warning only), does that qualify to be fit for a valid pr?

carltongibson · 2025-01-13T07:40:30Z

@IronJam11 You need to add a new test showing the issue. It should fail without your patch and pass with it.

Django has a tutorial for writing your first patch:

https://docs.djangoproject.com/en/dev//intro/contributing/#writing-some-tests-for-your-ticket

It's not exactly the same here, but the general ideas are the same.

IronJam11 · 2025-01-13T14:58:53Z

I have added a regression test as mentioned. Is there anything else I will have to attach?

bigfootjon · 2025-01-14T01:54:19Z

@IronJam11 it looks like you've REPLACED an existing test with your new test, we don't want to lose the old one!

IronJam11 · 2025-01-14T13:56:55Z

Apologies, I added the erased test

carltongibson · 2025-01-15T09:39:09Z

Looking close @IronJam11 — thanks.

I'm bemused by the existing assert code. The valid_group_name() method either returns True or raises, so the asserts can never fail — the TypeError is raised before the AssertionError would be. So the assert error message is never needed. 🤔 @bigfootjon Am I just misreading that?

(Not an issue with this PR @IronJam11!)

carltongibson · 2025-01-15T09:48:58Z

channels/layers.py

+        assert self.valid_group_name(group), (
+            f"Group name must be" f"less than {self.MAX_NAME_LENGTH} characters."
+        )


As per the point about the TypeError being raised before the AssertionError, it's not clear we need to make any change here, or on lines 344/349 and 353/360 above.

IronJam11 · 2025-01-15T19:39:05Z

You are absolutely right ! My bad there (I had actually used it to debug initially), i ran the tests again and it seems to be working just fine :)

bigfootjon

So the assert error message is never needed. 🤔 @bigfootjon Am I just misreading that?

Lol, yeah you're reading that right. We should probably remove the assert altogether and change the method name to require_valid_group_name so that behavior is more clear.

channels/layers.py

IronJam11 · 2025-01-21T11:54:24Z

I inlined it as well :), also other than this, if there are other issues to tackle, I will be more than happy to contribute :}

…ts whenever necessary

IronJam11 · 2025-01-21T12:19:29Z

So the assert error message is never needed. 🤔 @bigfootjon Am I just misreading that?

Lol, yeah you're reading that right. We should probably remove the assert altogether and change the method name to require_valid_group_name so that behavior is more clear.

I made the necessary changes

bigfootjon

Looking better!

bigfootjon · 2025-01-22T01:13:38Z

channels/layers.py

-        assert self.valid_group_name(group), "Group name not valid"
-        assert self.valid_channel_name(channel), "Channel name not valid"
+        self.require_valid_group_name(group)
+        self.valid_channel_name(channel), "Channel name not valid"


Can you rename valid_channel_name to require_valid_channel_name to match?

And also remove the , "Channel name not valid" since it isn't used?

bigfootjon · 2025-01-22T01:13:52Z

channels/layers.py


    async def group_discard(self, group, channel):
        # Both should be text and valid
        assert self.valid_channel_name(channel), "Invalid channel name"


Same here as aboev

IronJam11 · 2025-01-22T07:33:52Z

Added another test for channels
Made the error message inlined
Removed the unnecessary asserts

bigfootjon

One final comment!

bigfootjon · 2025-01-25T19:59:55Z

channels/layers.py

-
-        assert all(
-            self.valid_channel_name(channel, receive=receive) for channel in names
+        all(


The all doesn't have semantic value, can you refactor this as a normal for loop?

channels/layers.py

IronJam11 · 2025-01-26T08:45:09Z

Done as you said :)

bigfootjon

@carltongibson any final thoughts?

@IronJam11 please fix the lint errors as indicated in the failing signal on this PR

IronJam11 · 2025-01-27T05:40:10Z

sorry sir, done !!

carltongibson

Looks good. Just one small query?

carltongibson · 2025-01-27T10:42:28Z

channels/layers.py

-        return True
+        for channel in names:
+            self.require_valid_channel_name(channel, receive=receive)
+        return


Do we mean return True? return None (explicitly)? Which?

IronJam11 · 2025-01-27T11:35:28Z

yeah absolutely it is supposed to be return True.

add warning of length of group

2e8c005

carltongibson reviewed Jan 10, 2025

View reviewed changes

fix minor issues to pass the tests

a58f8d9

add regression test

19879b2

update the structure of the test code

1bbd2d9

add the erased test

cc46101

carltongibson reviewed Jan 15, 2025

View reviewed changes

remove unnecessary assertions

50f53bc

bigfootjon requested changes Jan 18, 2025

View reviewed changes

channels/layers.py Outdated Show resolved Hide resolved

inline the error_message

48533bd

change the function name to require_valid_group_name and remove asser…

a13f9eb

…ts whenever necessary

bigfootjon requested changes Jan 22, 2025

View reviewed changes

applying the same changes for channel

792c79e

IronJam11 requested a review from bigfootjon January 22, 2025 12:23

bigfootjon requested changes Jan 25, 2025

View reviewed changes

bigfootjon reviewed Jan 25, 2025

View reviewed changes

channels/layers.py Show resolved Hide resolved

refactor all to use for loop

ae711a3

bigfootjon approved these changes Jan 26, 2025

View reviewed changes

remove lint errors

027aad1

carltongibson reviewed Jan 27, 2025

View reviewed changes

correct the return instance

8b6c547

bigfootjon merged commit a144b4b into django:main Jan 28, 2025
7 checks passed

carltongibson mentioned this pull request Mar 30, 2025

Deprecation warning for valid_group_name method. AttributeError: 'RedisChannelLayer' object has no attribute 'valid_channel_name'. django/channels_redis#409

Open

Uh oh!

Conversation

IronJam11 commented Jan 10, 2025

Uh oh!

carltongibson left a comment

Choose a reason for hiding this comment

Uh oh!

carltongibson Jan 10, 2025

Choose a reason for hiding this comment

Uh oh!

IronJam11 commented Jan 11, 2025

Uh oh!

carltongibson commented Jan 11, 2025

Uh oh!

IronJam11 commented Jan 11, 2025

Uh oh!

IronJam11 commented Jan 11, 2025

Uh oh!

carltongibson commented Jan 13, 2025

Uh oh!

IronJam11 commented Jan 13, 2025

Uh oh!

bigfootjon commented Jan 14, 2025

Uh oh!

IronJam11 commented Jan 14, 2025

Uh oh!

carltongibson commented Jan 15, 2025

Uh oh!

carltongibson Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IronJam11 commented Jan 15, 2025

Uh oh!

bigfootjon left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

IronJam11 commented Jan 21, 2025

Uh oh!

IronJam11 commented Jan 21, 2025

Uh oh!

bigfootjon left a comment

Choose a reason for hiding this comment

Uh oh!

bigfootjon Jan 22, 2025

Choose a reason for hiding this comment

Uh oh!

bigfootjon Jan 22, 2025

Choose a reason for hiding this comment

Uh oh!

IronJam11 commented Jan 22, 2025

Uh oh!

bigfootjon left a comment

Choose a reason for hiding this comment

Uh oh!

bigfootjon Jan 25, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

IronJam11 commented Jan 26, 2025

Uh oh!

bigfootjon left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IronJam11 commented Jan 27, 2025

Uh oh!

carltongibson left a comment

Choose a reason for hiding this comment

Uh oh!

carltongibson Jan 27, 2025

Choose a reason for hiding this comment

Uh oh!

IronJam11 commented Jan 27, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

carltongibson Jan 15, 2025 •

edited

Loading

bigfootjon left a comment •

edited

Loading

bigfootjon left a comment •

edited

Loading