tracker issue : CF-3208541

select a category, or use search below
(searches all categories and all time range)
Title:

GetApplicationMetadata vs SessionGetMetadata

| View in Tracker

Status/Resolution/Reason: Closed/Withdrawn/AsDesigned

Reporter/Name(from Bugbase): Aaron Neff / Aaron Neff (Aaron Neff)

Created: 06/07/2012

Components: Language

Versions: 10.0

Failure Type:

Found In Build/Fixed In Build: Final /

Priority/Frequency: Major / Some users will encounter

Locale/System: English / Platforms All

Vote Count: 2

Currently, the CFML Reference correctly lists ApplicationGetMetadata and SessionGetMetadata. (Good!)

I filed #3207841 to delete the old "PRERELEASE - 02/17/2012 GetApplicationMetadata" doc. But that was marked Closed/Withdrawn/NotABug. A note on #3207841 states that ApplicationGetMetadata had been renamed to GetApplicationMetadata. (Why?)

This ticket here is regarding the inconsistency between GetApplicationMetadata and SessionGetMetadata.  Example:

List #1
- applicationStop
- applicationGetMetadata (documented in CF10 Final)
- sessionGetMetadata
- sessionInvalidate
- sessionRotate

vs

List #2
- applicationStop
- getApplicationMetadata (documented in CF10 Public Beta - PRERELEASE - 02/17/2012)
- sessionGetMetadata
- sessionInvalidate
- sessionRotate

It is a bug to have both "Get"ApplicationMetadata and Session"Get"Metadata.

How should this be fixed?

Suggestion:
1) Keep CF10's CFML Reference unchanged (meaning, keep ApplicationGetMetadata listed in CFML Reference)
2) Delete CF10 Public Beta PRERELEASE - 02/17/2012 doc (meaning, delete the old GetApplicationMetadata doc)

----------------------------- Additional Watson Details -----------------------------

Watson Bug ID:	3208541

External Customer Info:
External Company:  
External Customer Name: itisdesign
External Customer Email:

Attachments:

  1. June 29, 2012 00:00:00: 1_20120620_ApplicationGetMetadata.jpg
  2. June 29, 2012 00:00:00: 2_20120620_GetApplicationMetadata.jpg
  3. June 30, 2012 00:00:00: 3_20120630_ApplicationMetadataGet.jpg

Comments:

- Related Post: http://prerelease.adobe.com/r/?8ffe6eee961e4455b0cb4554354f0f55 - SessionGetMetadata doc: http://help.adobe.com/en_US/ColdFusion/10.0/CFMLRef/WSf23b27ebc7b554b6-67fd180f13585b7069d-8000.html - ApplicationGetMetadata doc: http://help.adobe.com/en_US/ColdFusion/10.0/CFMLRef/WSf23b27ebc7b554b6c43bda313671e094bb-8000.html - PRERELEASE - 02/17/2012 GetApplicationMetadata doc: http://help.adobe.com/en_US/ColdFusion/10.0/CFMLRef/WS578003649f39bc20-258e7ab21350d4577c9-8000.html
Comment by External U.
19072 | June 07, 2012 01:03:31 PM GMT
We did change the function name from 'ApplicationGetMetadata' to 'GetApplicationMetadata'. However, I see that there is documentation for both of them. Documentation for the former needs to be removed. (Comment added from ex-user id:sagarg)
Comment by Adobe D.
19073 | June 12, 2012 10:09:38 PM GMT
I've raised a documentation bug #CF-3212477. (Comment added from ex-user id:sagarg)
Comment by Adobe D.
19074 | June 12, 2012 10:14:18 PM GMT
It might be "by design", but in that case the design is wrong, and should be fixed. It seems to be an observation I am needing to make more and more often... sloppy lack of uniformity like this is making CF more and more PHP-like all the time. The ticket should be reopened.
Vote by External U.
19082 | June 14, 2012 01:46:18 PM GMT
Hi Sagar, The issue is the placement of the word "Get". In Session"Get"Metadata, the word "Get" is in the middle. In "Get"ApplicationMetadata, the word "Get" is at the beginning. These are different. How is it good? IMO, Application and Session functions should be named consistently. Thanks, -Aaron
Comment by External U.
19075 | June 20, 2012 02:50:16 AM GMT
well, we also have GetComponentMetadata, GetMetadata, GetVFSMetadata. GetApplicationMetadata fits right there. I agree there is some inconsistency in the language - in some cases, the method names start with the object/data on which operation happens and in some cases, it starts with operation. but we have to live with it. It was originally ApplicationGetMetadata but then changed to GetApplicationMetadata based on the feedback. we cant go back in history and change everything to make it consistent.
Comment by Rupesh K.
19076 | June 20, 2012 06:55:53 AM GMT
Hi Rupesh and Sagar, I do understand there are other Get*Metadata functions, but ApplicationGetMetadata and SessionGetMetadata are much more closely related to each other and thus GetApplicationMetadata/SessionGetMetadata is a conflicting naming combination. This is not just my feedback (proven by Adam's feedback/vote here). Regarding the feedback to change ApplicationGetMetadata to GetApplicationMetadata: SessionGetMetadata was added post-Beta, and undocumented until Final. MANY months after the feedback regarding ApplicationGetMetadata/GetApplicationMetadata. Had SessionGetMetadata been documented before release, then I strongly feel that supporters of GetApplicationMetadata would've disagreed w/ a GetApplicationMetadata/SessionGetMetadata combination. I believe it is not too late to fix this issue: Please see the 2 images I've just attached to this ticket (the 20120620_*Metadata.jpg images). They prove that GetApplicationMetadata is not in any official CF10 Final doc and that ApplicationGetMetadata _is_ the officially-documented function which should be fixed (since officially-documented means officially-supported). So, technically/legally, I believe we don't have to "go back in history" b/c: 1) GetApplicationMetadata is undocumented/unsupported in CF10 Final 2) ApplicationGetMetadata is documented/supported in CF10 Final (documented in multiple places) Also, the cautionary "Prerelease" wording currently atop the sole GetApplicationMetadata doc already warns developers that the GetApplicationMetadata function may not exist in a future release. Would the team please consider these points? Or _at least_ please permit participants in the next Prerelease to have a discussion on how to resolve this conflicting GetApplicationMetadata/SessionGetMetadata naming combination? Thanks, -Aaron
Comment by External U.
19077 | June 29, 2012 12:43:01 AM GMT
The CF10 Developer Week session on new features says it's "ApplicationMetadataGet". Please see the "20120630_ApplicationMetadataGet.jpg" screenshot I just attached to this ticket. This just adds to the confusion.
Comment by External U.
19078 | June 30, 2012 01:37:56 AM GMT
Hi all, Just noting that there are 2 more current discussions on this same topic: Ticket #CF-3207841 - https://bugbase.adobe.com/index.cfm?event=bug&id=CF-3207841 Public forums - http://forums.adobe.com/thread/1018978 Thanks, -Aaron
Comment by External U.
19079 | July 01, 2012 12:25:13 PM GMT
This is the first time I have ever had a problem with Adobe and I hope this will be the last.
Vote by External U.
19083 | October 30, 2012 02:32:23 PM GMT
Hi Rupesh, Regarding "It was originally ApplicationGetMetadata but then changed to GetApplicationMetadata based on the feedback." So why wasn't SessionGetMetadata() named GetSessionMetadata()? Regarding "we cant go back in history and change everything to make it consistent." If CF12 can break backward-compat, then can we please make these consistent? sessionInvalidate(), sessionRotate(), sessionGetMetadata, applicationStop(), and... applicationGetMetadata() Can this ticket be re-opened for CF12? Thanks!, -Aaron
Comment by External U.
19080 | May 17, 2015 01:13:00 PM GMT
> we cant go back in history and change everything to make it consistent. Yes. Yes you can. Well you don't need to time travel, all you need to do is implement whatever is needed to make CFML consistent, and deprecate the elements that break the consistency. Done. This is not rocket surgery.
Comment by External U.
19081 | January 09, 2016 05:08:00 AM GMT