Extension Manager:API Rewrite: Difference between revisions

← Older edit

Extension Manager:API Rewrite (view source)

Revision as of 22:25, 16 March 2010

859 bytes removed , 16 March 2010

no edit summary

Mossop

canmove, Confirmed users

1,570

edits

@@ Line 10: / Line 10: @@
 =High Level View=
-The new API is accessed through a global [[Extension Manager:API Rewrite:API#AddonManager|AddonManager]] object that is included in a JavaScript module. There will also be a limited amount of access provided through an XPCOM component but this is intended for the XRE to use during startup. The API makes no assumptions about what types of add-ons do and how they are used, it does make some basic assumptions about the information available about them and the install process.
+The new API is accessed through a global [[Extension Manager:API Rewrite:API#AddonManager|AddonManager]] object that is included in a JavaScript module. There will also be a limited amount of access provided through an XPCOM component but this is intended for platform integration only. The API makes no assumptions about what different types of add-ons do and how they are used, it does make some basic assumptions about the information available about them and the install process. Users of the API can register to receive events about all add-ons and installs.
-Users of the API can register to receive events about all add-ons. The API also gives access to two main types of objects:
+==Add-on Providers==
+Underneath the manager (and essentially invisible through the API) are a set of add-on providers. Each one manages a set of types of add-on, for example there can be a provider for XPI style add-ons, a provider for plugins, a provider for lightweight themes, etc. There will probably be a hardcoded set of providers for the application and then some means for add-ons to register their own providers. It is up to the providers to maintain their lists of installed add-ons, perform installation and uninstallation and send appropriate notifications out to registered listeners.
 ==Addon==
 The [[Extension Manager:API Rewrite:API#Addon|Addon]] object represents an add-on that is installed on the local system. This is a loose term since it also includes add-ons that have been downloaded and will be installed when the application is restarted. It is possible that the API will hand out multiple instances of Addon for the same underlying add-on. There are a set of properties that will be available for all types of add-ons and then each type of add-on may have additional properties. The same goes for operations that can be performed on the add-on.
-Certain add-ons may have restrictions over what operations can be performed. These restrictions could be just down to the nature of the add-on (themes cannot be disabled normally) or down to system policies (user's may not have access to uninstall some add-ons f.e.). Each Addon has a permissions property that indicates what operations can currently be performed.
+Certain add-ons may have restrictions over what operations can be performed. These restrictions could be just down to the nature of the add-on (themes cannot be disabled normally) or down to system policies (users may not have access to uninstall some add-ons for example). Each Addon has a permissions property that indicates what operations can currently be performed.
-Some types of add-ons may require restarts for certain operations. XPI style extensions for example require restarts for almost all operations. The API exposes the operations that are pending in the pendingOperations property. It is also possible that this property may be used to indicate operations that have been deferred for any reason, maybe timing issues, maybe a dependency is pending install. Pending operations can make it hard to tell what state an actual add-on is in. To help solve this the isActive property indicates whether the add-on is currently active. This is separate to and may be different to the various userDisabled, isCompatible and other properties that indicate whether an add-on can be active or not.
+Some types of add-ons may require restarts for certain operations. XPI style extensions for example require restarts for almost all operations. The API exposes the operations that are pending in the pendingOperations property. Pending operations can make it hard to tell what state an actual add-on is in. To help solve this the isActive property indicates whether the add-on is currently active. This is separate to and may be different to the various userDisabled, isCompatible and other properties that indicate whether an add-on can be active or not.
 Addon objects are live views of the underlying add-on. The properties are always guaranteed to be up to date.
 ==AddonInstall==
-The [[Extension Manager:API Rewrite:API#AddonInstall|AddonInstall]] object represents an add-on that is not yet installed or has just been installed. It may come from an update check to an existing add-on, a request to install a new add-on or a search for new add-ons. It tracks the high level progress of any necessary downloads and installation of the add-on.
+The [[Extension Manager:API Rewrite:API#AddonInstall|AddonInstall]] object represents an add-on that is not yet installed or has just been installed. It may come from an update check to an existing add-on, a request to install a new add-on or a search for new add-ons. It tracks the high level progress of any necessary downloads, dependencies and installation of the add-on.
 The AddonInstall goes through a set of states:
 ;Available :Represents an add-on that is known to be available for install. Depending on where the AddonInstall came from there may be very little information about the add-on available.
-;Downloading :This state tracks add-on downloads and as such it may not be necessary for add-ons installed from local files for example. During this state numerous progress events will be sent to listeners to inform them of the overall progress of the download as well as individual points of interest.
+;Downloading :This state is used to show that downloads are in progress for the add-on. During download progress information will be available but again very little information my be available about an add-on.
-;Downloaded :At this point all the main parts of the add-on's files are somewhere on the local computer to be installed. Almost all information about the add-on should be available at this point through an [[Extension Manager:API Rewrite:API#Addon|Addon]] object.
+;Downloaded :This state is entered if installation does not proceed after downloading completes. At this point all information about an add-on is available.
 ;Installing :Here the add-on is being installed by its provider. This may cover file extraction etc.
-;Checking :In some cases the install may be delayed to allow further work such as compatibility checking.
 ;Installed :Here the add-on has been installed and its Addon object will appear in AddonManager.getAddons. The add-on itself however may not be active until after an application restart.
+;Cancelled :If the install or download process is cancelled then the install object goes into a Cancelled state and cannot be restarted.
+;Failed :There are failure states for download and install, once in these states the install cannot be restarted.
-''These states are modelled on the current states XPI add-ons go through. Are they right?''
+Once the install process for an AddonInstall is started with <code>install</code> it will move through all of the states naturally sending out notifications at each transition and some progress events in between until either an error is encountered or the install is stopped by an install listener returning <code>false</code> from one of the notifications.
-In some ways it may make more sense for the checking phase to come between downloading and downloaded. This way when in the downloaded state we will know everything necessary to say whether installing is possible.
+Certain types on installs may skip steps. Installing an add-on from the file system for example may jump straight to the Downloaded state since there is no need to download it.
-''Should we automatically jump to states?''
+==Dependencies and Bootstrapping==
+It is anticipated that at some time automatic downloading of dependencies and bootstrap add-ons will be implemented. This is intended to happen in the AddonInstall Downloading and Checking states. Once the initial file for an add-on is downloaded the AddonManager checks to see if a repository is installed to handle it.
-If we have an AddonInstall for a local file should we jump straight to Downlaoded? Perhaps not if we move checking to earlier as suggested above.
-If we start an add-on download should it jump straight to installing as soon as downloading is complete and installation is known to be possible or should that be controlled through the API? In the latter case should we allow installation through the API even if the add-on is incompatible or has some other fault? I think it might be a good option in the API even if not exposed through the UI normally. It allows for better customisation on an application level or by extensions.
-==Add-on Providers==
-Underneath the manager (and essentially invisible through the API) are a set of add-on providers. Each one manages a specific type of add-on, for example there can be a provider for XPI style add-ons (perhaps multiple providers for each type of XPI add-on but that's unlikely), a provider for plugins, a provider for lightweight themes, etc. There will probably be a hardcoded set of providers for the application and then some means for add-ons to register their own providers. It is up to the providers to maintain their lists of installed add-ons, perform installation and uninstallation and send appropriate notifications out to registered listeners.
-The new APIs represent add-ons in a number of states but these can broadly be split into two types, Local add-ons and Available add-ons. The API objects representing these add-ons are considered live views of the add-on. As operations are performed (disabling, downloading etc.) the properties of the object will update to reflect the new state. The objects represent add-on instances however. If I have an object representing the installed add-on "foo", then the user uninstalls and then reinstalls "foo" then the object still represents the old uninstalled instance of "foo". It is undefined whether retrieving the same add-on from the API twice will give two references to the same object or two separate objects that have the same properties.
+If there is a repository to handle the add-on then it is used to check for compatibility, updates and dependency information. And dependent items will be downloaded before the AddonInstall moves to the Downloaded state, allowing the item to be installed and usable with minimal delay after that point.