[DRIVERS-2098] Is it acceptable to omit "session" prefix/suffix on ClientSession fields/methods Created: 28/Oct/19  Updated: 31/Mar/22

Status: Backlog
Project: Drivers
Component/s: Sessions
Fix Version/s: None

Type: Spec Change Priority: Major - P3
Reporter: Patrick Freed Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
Driver Changes: Needed

 Description   

The sessions spec defines the field for the ClientSession's id as sessionId and the method for ending the session as endSession. In both these cases, the "session" part of the identifiers seems redundant, seeing as the field and method are part of a ClientSession. In addition, variables that are ClientSessions will likely contain "session" somewhere in their names, so something like session.endSession() will be quite common. One argument for endSession is that it implies a server-side endSessions command will take place, but that isn't even happening due to session caching.

Considering all that, would it be acceptable for drivers to instead name these fields just id and end, assuming they haven't already released versions with sessionId and endSession? Then we'd have session.id and session.end(), which seem clearer and less redundant.



 Comments   
Comment by Esha Bhargava [ 13/Jan/20 ]

Should be permitted with naming deviations, but feel free to add language to support this.

Generated at Thu Feb 08 08:24:43 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.