feat: remove features enable/disable

Author: BolverBlitz

README.md

@@ -180,14 +180,13 @@ docker compose up -d
 
 ## Optional Features
 
-Optional features are installed from independent folders in `installed_features`.
+Optional features are installed and enabled by placing independent folders in `installed_features`.
 Each feature folder needs a `feature.json` or `config.json` manifest:
 
 ```json
 {
   "name": "foodorders",
   "version": "0.0.1",
-  "enabledByDefault": false,
   "navbar": {
     "insert": true,
     "href": "/foodorders",
@@ -198,17 +197,14 @@ Each feature folder needs a `feature.json` or `config.json` manifest:
     "href": "/admin/foodorders",
     "translationKeyBase": "Admin.FeatureCards.foodorders"
   },
-  "settings": {
-    "translationKeyBase": "AdminSettings.Features.foodorders"
-  },
   "db": {
     "migrations": [],
     "seeds": []
   }
 }
 ```
 
-On startup the app scans `installed_features/<featureName>`. If the feature version is newer than `config/features/<featureName>.json`, or if the installed config does not exist yet, the feature files are copied into the application.
+On startup the app scans `installed_features/<featureName>`. Folder presence enables the feature. If the feature version is newer than `config/features/<featureName>.json`, or if the installed config does not exist yet, the feature files are copied into the application.
 
 Supported feature folders include application folders such as `api`, `lib`, `src`, `views`, `public`, and `config`. A top-level `templates` folder is installed into `config/templates`. Feature translations live in:
 

api/settings.js

@@ -15,8 +15,6 @@ const { verifyBufferIsJPG, verifyBufferIsJPGMaxDimensions, convertToWebp } = req
 const { getBackups, createBackup, restoreBackup } = require('@lib/backup');
 const { generateManifest } = require('@lib/manifest');
 const { InvalidRouteInput } = require('@lib/errors');
-const { ViewRenderer } = require('@lib/template');
-const { loadFeatureDefinitions } = require('@lib/features');
 const { isEBGOAuthEnabled } = require('@lib/oauth');
 const Joi = require('@lib/sanitizer');
 const express = require('ultimate-express');
@@ -35,9 +33,8 @@ const uploadHandler = multer({
     limits: { fileSize: 2 * 1024 * 1024 * 1024 } // 2GB file size limit
 });
 
-// Dynamically generate the schema for toggling settings based on available features
 const getSettingsToggleSchema = () => {
-    const settingKeys = ['USER_SHOPPINGLIST_ACTIVE', 'DB_AUTOVACUUM', 'LOW_FUNDS_WARNING', ...Object.keys(loadFeatureDefinitions()).map((featureName) => `feature_${featureName}`)];
+    const settingKeys = ['USER_SHOPPINGLIST_ACTIVE', 'DB_AUTOVACUUM', 'LOW_FUNDS_WARNING'];
     if (!isEBGOAuthEnabled()) settingKeys.unshift('REG_CODE_ACTIVE');
 
     return Joi.object({
@@ -70,9 +67,6 @@ router.get('/', verifyRequest('app.admin.settings.read'), limiter(1), async (req
 router.post('/toggle', verifyRequest('app.admin.settings.write'), limiter(1), async (req, res) => {
     const body = await getSettingsToggleSchema().validateAsync(req.body);
     const result = await toggleSetting(body.setting_key);
-    if (body.setting_key.startsWith('feature_')) {
-        new ViewRenderer().flushAllCachesAndRenderStaticPages();
-    }
     return res.json({ success: true, new_value: result });
 });
 

config/application.js

@@ -1,3 +1,3 @@
 module.exports = {
-    dbVersion: 1782000000, // Minimum database version
+    dbVersion: 1782166516, // Minimum database version
 }

config/locals_map.js

@@ -9,13 +9,6 @@ module.exports = {
         "Categories",
         "AdminUsers"
     ],
-    "/admin/:uuid/itembuyers": [
-        "Admin",
-        "Error",
-        "Page",
-        "Items",
-        "Navbar"
-    ],
     "/admin/:uuid/edituser": [
         "Admin",
         "Error",
@@ -25,6 +18,13 @@ module.exports = {
         "Navbar",
         "AdminUsers"
     ],
+    "/admin/:uuid/itembuyers": [
+        "Admin",
+        "Error",
+        "Page",
+        "Items",
+        "Navbar"
+    ],
     "/admin/:uuid/transactions": [
         "Admin",
         "AdminUsers",

lib/features.js

@@ -15,10 +15,8 @@ const manifestCandidates = ['feature.json', 'config.json'];
  * @typedef {Object} FeatureManifest
  * @property {String} name Safe feature identifier used for settings, config files, and install paths.
  * @property {String} version Feature version used to decide whether an installed feature should be updated.
- * @property {Boolean} enabledByDefault Whether migrations/settings should enable the feature by default.
  * @property {Object} navbar Navbar metadata used when a feature adds a navigation entry.
  * @property {Object} adminCard Admin feature-card metadata for the admin overview.
- * @property {Object} settings Admin settings metadata for the feature toggle.
  * @property {Object} db Database migration and seed file references.
  * @property {Object.<String, String[]>} localsMap Extra translation keys needed by route.
  */
@@ -111,7 +109,6 @@ const normalizeManifest = (manifest, fallbackName) => {
         ...manifest,
         name,
         version: manifest.version || '0.0.0',
-        enabledByDefault: manifest.enabledByDefault === true,
         navbar: {
             insert: manifest.navbar?.insert === true,
             href: manifest.navbar?.href || `/${name}`,
@@ -123,9 +120,6 @@ const normalizeManifest = (manifest, fallbackName) => {
             href: manifest.adminCard?.href || manifest.href || `/admin/${name}`,
             translationKeyBase: manifest.adminCard?.translationKeyBase || manifest.translationKeyBase || `Admin.FeatureCards.${name}`,
         },
-        settings: {
-            translationKeyBase: manifest.settings?.translationKeyBase || manifest.settingsTranslationKeyBase || `AdminSettings.Features.${name}`,
-        },
         db: {
             migrations: Array.isArray(manifest.db?.migrations) ? manifest.db.migrations : [],
             seeds: Array.isArray(manifest.db?.seeds) ? manifest.db.seeds : [],
@@ -346,39 +340,6 @@ const loadFeatureDefinitions = () => {
         }, {});
 };
 
-/**
- * Returns only the enabled feature definitions and annotates each one with enabled: true.
- * @param {Object.<String, Boolean>} featureSettings Feature enablement map, keyed by feature name.
- * @returns {Object.<String, FeatureManifest & {enabled: Boolean}>} Enabled feature definitions keyed by feature name.
- */
-const getEnabledFeatures = (featureSettings) => {
-    const featureDefinitions = loadFeatureDefinitions();
-    return Object.entries(featureDefinitions).reduce((enabledFeatures, [featureName, definition]) => {
-        if (featureSettings[featureName] === true) {
-            enabledFeatures[featureName] = {
-                ...definition,
-                enabled: true,
-            };
-        }
-        return enabledFeatures;
-    }, {});
-};
-
-/**
- * Returns only enabled feature definitions without adding extra fields.
- * @param {Object.<String, Boolean>} featureSettings Feature enablement map, keyed by feature name.
- * @returns {Object.<String, FeatureManifest>} Enabled feature definitions keyed by feature name.
- */
-const getEnabledFeatureDefinitions = (featureSettings) => {
-    const featureDefinitions = loadFeatureDefinitions();
-    return Object.entries(featureDefinitions).reduce((enabledFeatureDefinitions, [featureName, definition]) => {
-        if (featureSettings[featureName] === true) {
-            enabledFeatureDefinitions[featureName] = definition;
-        }
-        return enabledFeatureDefinitions;
-    }, {});
-};
-
 /**
  * Resolves a public asset path for an installed feature.
  * @param {String} featureName Feature name whose installed_features/<feature>/public directory should be used.
@@ -404,8 +365,6 @@ module.exports = {
     featureLocalesDir,
     installFeatures,
     loadFeatureDefinitions,
-    getEnabledFeatures,
-    getEnabledFeatureDefinitions,
     getFeaturePublicFilePath,
     compareVersions,
 };

lib/sqlite/settings.js

@@ -50,38 +50,10 @@ const checkIfSettingTrue = async (key) => {
     return currentValue ? currentValue.setting_value === 'true' : false;
 };
 
-/**
- * Get all feature flags from app settings.
- * Settings are stored as feature_<name> and exposed as { [name]: boolean }.
- * @returns {Object}
- */
-const getFeatureSettings = () => {
-    const settings = db.prepare("SELECT setting_key, setting_value FROM app_settings WHERE setting_key LIKE 'feature_%'").all();
-    return settings.reduce((features, setting) => {
-        const featureName = setting.setting_key.replace(/^feature_/, '');
-        features[featureName] = setting.setting_value === 'true';
-        return features;
-    }, {});
-};
-
-/**
- * Ensure every installed feature has a toggle setting.
- * @param {Object} featureDefinitions
- */
-const ensureFeatureSettings = (featureDefinitions) => {
-    const insertSetting = db.prepare('INSERT OR IGNORE INTO app_settings (setting_key, setting_value) VALUES (?, ?)');
-
-    Object.entries(featureDefinitions).forEach(([featureName, definition]) => {
-        insertSetting.run(`feature_${featureName}`, definition.enabledByDefault === true ? 'true' : 'false');
-    });
-};
-
 module.exports = {
     getSettings,
     getSetting,
     toggleSetting,
     updateSetting,
-    checkIfSettingTrue,
-    getFeatureSettings,
-    ensureFeatureSettings
+    checkIfSettingTrue
 };

lib/template.js

@@ -9,8 +9,7 @@ const { deepMerge } = require('@lib/utils');
 
 const auth = require('@config/auth.js');
 const { default_group, default_member_group } = require('@config/permissions.js');
-const { loadFeatureDefinitions, getEnabledFeatures, getEnabledFeatureDefinitions } = require('@lib/features.js');
-const { getFeatureSettings } = require('@lib/sqlite/settings.js');
+const { loadFeatureDefinitions } = require('@lib/features.js');
 const { getEBGOAuthAuthorizeUrl, isEBGOAuthEnabled } = require('@lib/oauth.js');
 
 const startupUnixTime = Math.floor(Date.now() / 1000); // Keeping global cuz the dynamic pages would trigger a lot of CDN overwrites
@@ -71,12 +70,9 @@ class ViewRenderer {
             return result;
         }, {});
 
-        const featureSettings = getFeatureSettings();
         const featureDefinitions = loadFeatureDefinitions();
         const featureLangData = process.availableFeatureLanguages?.[langCode] || {};
-        const featureNames = page === '/admin/settings'
-            ? Object.keys(featureDefinitions)
-            : Object.entries(featureSettings).filter(([, enabled]) => enabled).map(([featureName]) => featureName);
+        const featureNames = Object.keys(featureDefinitions);
 
         featureNames.forEach(featureName => {
             if (!featureLangData[featureName]) return;
@@ -401,7 +397,6 @@ class ViewRenderer {
 const getContextObject = () => {
     if (cachedContextObject) return cachedContextObject;
 
-    const featureSettings = getFeatureSettings();
     const featureDefinitions = loadFeatureDefinitions();
     cachedContextObject = {
         Github: {
@@ -411,9 +406,8 @@ const getContextObject = () => {
             OAuthUrl: `${auth.Google.url}?client_id=${auth.Google.clientID}&redirect_uri=${auth.Google.url_redirect}&response_type=code&scope=${auth.Google.url_scope.join(' ')}`,
         },
         curentUnixTime: startupUnixTime,
-        features: getEnabledFeatures(featureSettings),
-        featureDefinitions: getEnabledFeatureDefinitions(featureSettings),
-        featureSettingsDefinitions: featureDefinitions,
+        features: featureDefinitions,
+        featureDefinitions,
         default_group: default_group,
         countryConfig: process.countryConfig,
         permissions_groups: Object.keys(process.permissions_config.groups),

migrations/1782166516-RemoveFeatureSettings.sql

@@ -0,0 +1,2 @@
+DELETE FROM app_settings
+WHERE setting_key LIKE 'feature_%';

public/appjs/translate.js

@@ -84,9 +84,9 @@ document.addEventListener("DOMContentLoaded", async () => {
             Object.entries(features)
                 .map(([featureName, feature]) => ({
                     name: featureName,
-                    config: typeof feature === 'object' ? feature : { enabled: feature === true },
+                    config: typeof feature === 'object' ? feature : {},
                 }))
-                .filter(({ config }) => config.enabled === true && config.navbar?.insert === true)
+                .filter(({ config }) => config.navbar?.insert === true)
                 .filter(({ config }) => !config.navbar.permission || checkPermission(config.navbar.permission).result)
                 .sort((left, right) => (left.config.navbar.order || 100) - (right.config.navbar.order || 100))
                 .forEach(({ name, config }) => {

src/app.js

@@ -14,8 +14,7 @@ const { getManifest } = require('@lib/manifest');
 const { countUsers } = require('@lib/sqlite/users');
 const { backfillStatistics } = require('@lib/sqlite/stats');
 const { getStaticFilePath } = require('@lib/imageStore');
-const { loadFeatureDefinitions, getFeaturePublicFilePath } = require('@lib/features');
-const { ensureFeatureSettings } = require('@lib/sqlite/settings');
+const { getFeaturePublicFilePath } = require('@lib/features');
 const { isEBGOAuthEnabled } = require('@lib/oauth');
 const { startNotificationWorker } = require('@lib/notifications');
 
@@ -77,7 +76,6 @@ if (dbMigration === 0) {
     }
 }
 
-ensureFeatureSettings(loadFeatureDefinitions());
 backfillStatistics(); // Backfill statistics data
 
 // Redirect root to setup