Code

Opened 7 years ago

Closed 6 years ago

#4720 closed (fixed)

feed class get_object has no opportunity to object to not having a url

Reported by: Bill Fenner <fenner@…> Owned by: cablehead
Component: contrib.syndication Version: master
Severity: Keywords:
Cc: cablehead Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

I have a feed that looks almost exactly like the "complex example" given in the manual for chicagocrime.org:

class DocumentComments(Feed):
    feed_type = Atom1Feed
    def get_object(self, bits):
        if len(bits) != 1:
            raise InternetDraft.DoesNotExist
        return InternetDraft.objects.get(filename=bits[0])

I assumed that since that method existed, it would be called for all requests, and a request for the "base" url of the feed would result in the DoesNotExist exception. Instead, I get "AttributeError: 'NoneType' object has no attribute 'filename'", since in link() I use obj.filename and obj is getting set to None.

I don't like having a known url for a 500 error, since I expect users to try to hack the urls and see what they can see.

I've attached a proposed diff. It always calls get_object, and creates a default get_object method that returns None. This should keep the existing behavior (and, in fact, works fine with my other feeds that don't take objects), and allows the user's class to handle a bits=[] if they would like to.

With the existing setup, the only way I can think of to not provide a 500 error when visiting this feed without an additional URL portion is to test for obj == None in the link method, and I can only do that because I know that the link one is the first one called - way too much internal knowledge of the feed class.

Attachments (3)

syndication-500.diff (1020 bytes) - added by Bill Fenner <fenner@…> 7 years ago.
syndication-500-2.diff (3.4 KB) - added by Andy Gayton <andy-django@…> 6 years ago.
syndication-500-2-alt.diff (4.2 KB) - added by Andy Gayton <andy-django@…> 6 years ago.
When in rome …

Download all attachments as: .zip

Change History (10)

Changed 7 years ago by Bill Fenner <fenner@…>

comment:1 Changed 7 years ago by cablehead

  • Cc cablehead added
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

I was banging my head reading the docs, trying to work out how this could have worked as is, and finally checked chicagocrime.org. They are throwing a 500 error there: http://www.chicagocrime.org/rss/beats/

comment:2 Changed 7 years ago by ubernostrum

  • Triage Stage changed from Unreviewed to Accepted

Yeah, this is an annoyance in the feeds system and should be fixed.

comment:3 Changed 6 years ago by Andy Gayton <andy-django@…>

The attached patch has been working well at http://rst2a.com for the last 2 or so months.

comment:4 Changed 6 years ago by Andy Gayton <andy-django@…>

  • Needs documentation set
  • Needs tests set
  • Owner changed from nobody to cablehead

Grabbing to add tests, and to update doco for this patch.

Changed 6 years ago by Andy Gayton <andy-django@…>

comment:5 Changed 6 years ago by Andy Gayton <andy-django@…>

  • Needs documentation unset
  • Needs tests unset
  • Triage Stage changed from Accepted to Ready for checkin
  • fixed up usage of tabs in the original patch
  • added stripping out empty strings from bits to the patch - it seems like
        if len(bits) != 1:
            raise InternetDraft.DoesNotExist

should handle the case of an empty url, instead of having:

        return InternetDraft.objects.get(filename=bits[0])

hit the db with an empty string.

  • added a failing (now passing) unit test
  • updated docs

Changed 6 years ago by Andy Gayton <andy-django@…>

When in rome ...

comment:6 Changed 6 years ago by Andy Gayton <andy-django@…>

I feel like I'm going against the grain by strictly testing at the unit level.

syndication-500-2-alt.diff is an alternate patch, which tests things by invoking the full request stack. It's less unit-y, but might be more inline with the django way of doing things.

comment:7 Changed 6 years ago by mtredinnick

  • Resolution set to fixed
  • Status changed from new to closed

(In [7328]) Merged the tests and documentation from #4720 to support the changes in [7295].
Thanks, Andy Gayton. Fixed #4720. Refs #5855.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.