Display deprecation notices in api output and api explorer #4340
Conversation
|
very cool. Nice solution. Makes me wonder if we should think about making our change log part of the api in a similar way (ie. some function that advises when an api function was introduced) |
colemanw
force-pushed
the
deprecatedApi
branch
2 times, most recently
from
29255ba to
b55db16
Compare
|
Thanks eileen... but now the question is, why is this causing the test suite to fall over? |
colemanw
force-pushed
the
deprecatedApi
branch
2 times, most recently
from
3887a4b to
d97370c
Compare
|
I'd like to see if it will fail the same way a second time - it kind of looks like it is failing because of the skipped test threshhold - what does it do locally? |
|
test this please |
| * @return string to indicate this entire api entity is deprecated | ||
| */ | ||
| function _civicrm_api3_mailing_group_deprecation() { | ||
| return 'The mailing_group api is deprecated. Use the mailing_event apis instead.'; |
There was a problem hiding this comment.
I just spotted a possible reason for test problem. The test failed just before showing evidence of running the checkTitle on this api. I can see that mailing_deprecation returns an array & this returns a string - maybe related?
|
Thanks for looking at this Eileen. I'm not quite sure where your train of thought is going wrt test threshold - do you have a theory there? Wrt string vs array - both are valid return values and they get interpreted differently by the api wrapper. As I tried to indicate in the comments: If the function returns a string, then the entire api entity is reported as deprecated. If it returns an array, then each array key represents a deprecated action. If you are not able to make sense of the jenkins output any better than me and we are getting into the realm of guessing, then I could just try disabling random parts of this PR and re-running the tests on it. |
|
One more thing to try before I resort to random guessing - the MailingEvent tests don't work for me locally (something about my version of php I think) but @totten would you would be willing to check the tests around that spot and see if you can get any clues? |
|
Running the test locally and hacking in some debug statements shows infinite recursion on an API call for mailing_group.getfields -- https://gist.github.com/totten/85514fd98b1c7dbcb2dd |
|
was it so easy to spot my random guessing? |
|
I think @totten just saved us both from a lot of random guessing. Fingers crossed for this fix... |
|
Hooray! |
|
never let him go on holiday again! |
colemanw
force-pushed
the
deprecatedApi
branch
from
a19fab7 to
30e6d6c
Compare
colemanw
force-pushed
the
deprecatedApi
branch
from
30e6d6c to
9277661
Compare
Display deprecation notices in api output and api explorer
https://issues.civicrm.org/jira/browse/CRM-15417