This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.

Bug 9790 - Request is not a good suffix for all the async interfaces in IndexedDB
Summary: Request is not a good suffix for all the async interfaces in IndexedDB
Alias: None
Product: WebAppsWG
Classification: Unclassified
Component: Indexed Database API (show other bugs)
Version: unspecified
Hardware: All All
: P2 normal
Target Milestone: ---
Assignee: Andrei Popescu
QA Contact: public-webapps-bugzilla
Depends on:
Reported: 2010-05-21 16:28 UTC by Jeremy Orlow
Modified: 2010-11-01 04:55 UTC (History)
6 users (show)

See Also:


Description Jeremy Orlow 2010-05-21 16:28:05 UTC
Andrei Popescu proposed a couple naming changes to the interfaces within IndedexDB deep within the "[IndexDB] Proposal for async API changes" thread [1].

One of the proposals was to change the "Request" suffix that's used for all the asynchronous interfaces (but not necessarily the IDBRequest object, since that's a bit different).

The voices are Andrei, Shawn, Jonas, and Jeremy in that order:

> >>> - The "Request" suffix is now used to denote the asynchronous versions
> >>> of the API interfaces. These interfaces aren't actually Requests of
> >>> any kind, so I would like to suggest changing this suffix. In fact, if
> >>> the primary usage of this API is via its async version, we could even
> >>> drop this suffix altogether and just add "Sync" to the synchronous
> >>> versions?
> >>
> >> I agree that Request seems confusing and seems to be contrary to what other
> >> specs use.  We should try to follow what other specs do here.
> >
> > Agreed on both accounts. There unfortunately isn't much in the way of
> > precedence here. There are three other specs to look at here, which
> > specify API for both workers and main thread.
> >
> > * Web Workers spec
> > This spec
> > doesn't actually use different interfaces for workers and main thread.
> > * File API Specifies FileReader
> > and FileReaderSync. The two interfaces are separate and doesn't
> > inherit from a common base
> > * WebSQLDatabase Specifies
> > separate interfaces, like Database and DatabaseSync. The two
> > interfaces are separate and doesn't inherit from a common base.
> >
> > I think we should follow the same convention as File API and
> > WebSQLDatabase. There really isn't anything to be gained by having a
> > common base interface, it just makes the spec harder to read as
> > functionality is distributed between the base interface and the
> > sync/async interface.
> >
> > I additionally like the naming convention. The async interfaces is
> > probably the interface that people will use first. Additionally that
> > interface is available both to workers and to the main thread. So it
> > makes sense to give the async interface the simpler name.
> Agreed on all counts.  I would add that, if we did decide to keep
> base interfaces, we could always suffix them with Base (which I
> think makes it more clear they're base interfaces)...but it sounds
> like that might not be necessary.

Comment 1 Andrei Popescu 2010-06-22 13:56:55 UTC
Fixed in
Comment 2 Nikunj Mehta 2010-06-26 23:59:54 UTC
Because all the abstract interfaces were removed, it was necessary to correct NoInterfaceObject modifiers on IDBObjectStore, IDBCursor, IDBObjectStoreSync, and IDBCursorSync
Comment 3 Jonas Sicking (Not reading bugmail) 2010-10-25 18:09:00 UTC
Nikunj: You reopened this, what is left here to do?
Comment 4 Jonas Sicking (Not reading bugmail) 2010-11-01 04:55:32 UTC
I'm closing this for now as "Request" is indeed no longer used as a suffix.

Nikunj, if you think there's still something missing here, please do reopen this bug or file a new one.