chore: extension registry embed in distributable for better first use UX

Author: abose

.gitignore

@@ -79,6 +79,7 @@ test/thirdparty/jasmine-reporters
 !/src/extensions/dev/README.*
 
 /src/extensions/disabled
+/src/extensions/registry
 
 # ignore .disabled file for default extensions
 /src/extensions/default/*/.disabled

gulpfile.js/thirdparty-lib-copy.js

@@ -22,27 +22,37 @@
 
 const { src, dest, series } = require('gulp');
 const fs = require("fs");
+const path = require('path');
 
 // removed require('merge-stream') node module. it gives wired glob behavior and some files goes missing
 const rename = require("gulp-rename");
 
 
 // individual third party copy
-function copyLicence(path, name) {
+function copyLicence(filePath, name) {
     console.log(`Copying licence file ${name}.markdown`);
-    return src(path)
+    return src(filePath)
         .pipe(rename(`${name}.markdown`))
         .pipe(dest('src/thirdparty/licences/'));
 }
 
-function renameFile(path, newName, destPath) {
-    console.log(`Renaming file ${path} to ${newName}`);
-    return src(path)
+function renameFile(filePath, newName, destPath) {
+    console.log(`Renaming file ${filePath} to ${newName}`);
+    return src(filePath)
         .pipe(rename(newName))
         .pipe(dest(destPath));
 }
 
+function ensureDirectoryExists(filePath) {
+    const dir = path.dirname(filePath);
+    if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true });
+    }
+}
+
 function downloadFile(url, outputPath) {
+    console.log(`Downloading file ${url} to ${outputPath}`);
+    ensureDirectoryExists(outputPath);
     return fetch(url)
         .then(x => {
             if(x.status !== 200){
@@ -76,6 +86,11 @@ function _createListDirJson(dirPath, jsonFileName) {
     fs.writeFileSync(`${dirPath}/${jsonFileName}`, JSON.stringify(filenames));
 }
 
+function _getConfigJSON() {
+    let configPath = "src/config.json";
+    console.log("Reading phoenix Config :", configPath);
+    return JSON.parse(fs.readFileSync(configPath, "utf8"));
+}
 
 /**
  * Add thirdparty libs copied to gitignore except the licence file.
@@ -107,6 +122,13 @@ let copyThirdPartyLibs = series(
         'src/thirdparty/bugsnag-performance.min.js'),
     downloadFile.bind(downloadFile, 'https://d2wy8f7a9ursnm.cloudfront.net/v2/bugsnag-performance.min.js.map',
         'src/thirdparty/bugsnag-performance.min.js.map'),
+    // phoenix extension registry cache for first time load
+    downloadFile.bind(downloadFile, _getConfigJSON().config.extension_registry,
+        'src/extensions/registry/registry.json'),
+    downloadFile.bind(downloadFile, _getConfigJSON().config.extension_registry_version,
+        'src/extensions/registry/registry_version.json'),
+    downloadFile.bind(downloadFile, _getConfigJSON().config.extension_registry_popularity,
+        'src/extensions/registry/popularity.json'),
     // tern js
     copyFiles.bind(copyFiles, ['node_modules/tern/defs/**/*'], 'src/thirdparty/tern/defs'),
     copyFiles.bind(copyFiles, ['node_modules/tern/lib/**/*'], 'src/thirdparty/tern/lib'),

src/extensibility/ExtensionManager.js

@@ -342,7 +342,7 @@ define(function (require, exports, module) {
      * Downloads the registry of Brackets extensions and stores the information in our
      * extension info.
      *
-     * @param {boolean} force - true to fetch registry from server fresh every time
+     * @param {boolean} [force] - true to fetch registry from server fresh every time
      * @return {$.Promise} a promise that's resolved with the registry JSON data
      * or rejected if the server can't be reached.
      */
@@ -367,6 +367,7 @@ define(function (require, exports, module) {
                         if(!pendingDownloadRegistry.alreadyResolvedFromCache){
                             _populateExtensions(registry);
                             pendingDownloadRegistry.resolve();
+                            pendingDownloadRegistry.alreadyResolvedFromCache = true;
                         }
                     }).finally(()=>{
                         pendingDownloadRegistry = null;
@@ -386,11 +387,31 @@ define(function (require, exports, module) {
             return pendingDownloadRegistry.promise();
         }
 
+        async function _getLocalRegistry() {
+            // the extension registry is like 1.5MB. A local copy is packaged in the src/extensions/registry/ folder
+            // so that on first launch, the user can see the extension manager instantly(though outdated).
+            // The local registry is created at build time and will get outdated if the user uses an old installer.
+            // but it will get updated when the user clicks on extension manager.
+            try {
+                const response = await fetch("extensions/registry/registry.json");
+                if (response.ok) {
+                    return await response.json();
+                } else {
+                    console.error(`Failed to fetch local registry: ${response.status} ${response.statusText}`);
+                    return null;
+                }
+            } catch (error) {
+                console.error(`Error fetching local registry: ${error.message}`);
+                return null;
+            }
+        }
+
         _getCachedRegistry() // never rejects
             .then(registryJson => {
                 if(registryJson) {
                     // we always immediately but after the promise chain is setup after function return (some bug sigh)
                     // resolve for ui responsiveness and then check for updates.
+                    console.log("Using cached extension registry");
                     setTimeout(()=>{
                         Metrics.countEvent(Metrics.EVENT_TYPE.EXTENSIONS, "registry", "cachedUse");
                         let registry = JSON.parse(registryJson);
@@ -399,6 +420,19 @@ define(function (require, exports, module) {
                         pendingDownloadRegistry.resolve();
                     }, 0);
                     pendingDownloadRegistry.alreadyResolvedFromCache = true;
+                } else {
+                    _getLocalRegistry().then(localRegistry => {
+                        if(!localRegistry ||
+                            !pendingDownloadRegistry || pendingDownloadRegistry.alreadyResolvedFromCache) {
+                            return;
+                        }
+                        console.log("Using outdated local extension registry as no cached registry found.");
+                        Metrics.countEvent(Metrics.EVENT_TYPE.EXTENSIONS, "registry", "outdatedUse");
+                        localRegistry = _filterIncompatibleEntries(localRegistry);
+                        _populateExtensions(localRegistry);
+                        pendingDownloadRegistry.resolve();
+                        pendingDownloadRegistry.alreadyResolvedFromCache = true;
+                    });
                 }
                 // check for latest updates even if we have cache
                 _shouldUpdateExtensionRegistry()