From: ludo@gnu.org (Ludovic Courtès)
To: Jelle Licht <jlicht@fsfe.org>
Cc: guix-devel <guix-devel@gnu.org>
Subject: Re: Maintaining implementations of similar utility functions like json-fetch
Date: Sat, 27 Jan 2018 17:09:11 +0100 [thread overview]
Message-ID: <87po5v1dy0.fsf@gnu.org> (raw)
In-Reply-To: <CAPsKtf+w=g15EHAhWqgw+2BqwPW581JzbsvxkGGOTu8wNx1T3g@mail.gmail.com> (Jelle Licht's message of "Fri, 26 Jan 2018 16:28:28 +0100")
Hello!
Jelle Licht <jlicht@fsfe.org> skribis:
> I noticed that there are currently two very similar functions for fetching
> json data; `json-fetch' in (guix import json) and `json-fetch*' in (guix
> import github).
>
> Some things I noticed:
> - Dealing with http error codes seems to be a bit more robust in
> `json-fetch*'.
> - Making sure that (compliant) servers give responses in the proper format
> seems more robust in `json-fetch' due to using Accept headers.
> - Dealing with the fact that json responses are technically allowed to be
> lists of objects, which `json-fetch' does not handle gracefully.
>
> For this issue specifically, would it make sense to combine the two
> definitions into a more general one?
Definitely, we should just keep one. It’s not even clear how we ended
up with the second one.
> My more general concern would be on how we can prevent bug fixes only being
> applied to one of several nearly identical functions. IOW, should we try to
> prevent situations like this from arising, or is it okay if we somehow make
> sure that fixes should be applied to both locations?
We should prevent such situations from arising, and I think we do.
The difficulty is that avoiding duplication requires knowing the whole
code base well enough. Sometimes you just don’t know that a utility
function is available so you end up writing your own, and maybe the
reviewers don’t notice either and it goes through; or sometimes you need
a slightly different version so you duplicate the function instead of
generalizing it.
Anyway, when we find occurrences of this pattern, we should fix them!
Thanks,
Ludo’.
next prev parent reply other threads:[~2018-01-27 16:09 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-01-26 15:28 Maintaining implementations of similar utility functions like json-fetch Jelle Licht
2018-01-27 16:09 ` Ludovic Courtès [this message]
2018-01-31 17:32 ` Jelle Licht
2018-02-01 11:54 ` Catonano
2018-02-01 12:14 ` Gábor Boskovits
2018-02-05 13:12 ` Ludovic Courtès
2018-02-05 14:51 ` Alex Vong
2018-06-10 18:50 ` Jelle Licht
2018-06-10 19:54 ` Ludovic Courtès
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87po5v1dy0.fsf@gnu.org \
--to=ludo@gnu.org \
--cc=guix-devel@gnu.org \
--cc=jlicht@fsfe.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.