Updated messaging around {{get}} helper access

closes #10447

- Get helper message talks about the old API, but upgrading is the best way to solve the problem
- Had to create a way to add a custom message to a labs enabled helper to achieve this

core/server/helpers/get.js

@@ -197,7 +197,10 @@ module.exports = function getLabsWrapper() {
             flagKey: 'publicAPI',
             flagName: 'Public API',
             helperName: 'get',
-            helpUrl: 'https://docs.ghost.org/faq/api-versioning/',
+            // Even though this is a labs enabled helper, really we want users to upgrade to v2 API.
+            errMessagePath: 'warnings.helpers.get.apiRequired.message',
+            errContextPath: 'warnings.helpers.get.apiRequired.context',
+            helpUrl: 'https://docs.ghost.org/api/handlebars-themes/packagejson/',
             async: true
         }, function executeHelper() {
             return get.apply(self, args);

core/server/services/labs.js

@@ -18,7 +18,8 @@ labs.isSet = function isSet(flag) {
 };
 
 labs.enabledHelper = function enabledHelper(options, callback) {
-    var errDetails, errString;
+    const errDetails = {};
+    let errString;
 
     if (labs.isSet(options.flagKey) === true) {
         // helper is active, use the callback
@@ -26,14 +27,12 @@ labs.enabledHelper = function enabledHelper(options, callback) {
     }
 
     // Else, the helper is not active and we need to handle this as an error
-    errDetails = {
+    errDetails.message = common.i18n.t(options.errMessagePath || 'warnings.helpers.helperNotAvailable', {helperName: options.helperName}),
-        message: common.i18n.t('warnings.helpers.helperNotAvailable', {helperName: options.helperName}),
+    errDetails.context = common.i18n.t(options.errContextPath || 'warnings.helpers.flagMustBeEnabled', {
-        context: common.i18n.t('warnings.helpers.flagMustBeEnabled', {
+        helperName: options.helperName,
-            helperName: options.helperName,
+        flagName: options.flagName
-            flagName: options.flagName
+    });
-        }),
+    errDetails.help = common.i18n.t(options.errHelpPath || 'warnings.helpers.seeLink', {url: options.helpUrl});
-        help: common.i18n.t('warnings.helpers.seeLink', {url: options.helpUrl})
-    };
 
     common.logging.error(new common.errors.DisabledFeatureError(errDetails));
 

core/server/translations/en.json

@@ -565,7 +565,11 @@
                 "iteratorNeeded": "Need to pass an iterator to #foreach"
             },
             "get": {
-                "invalidResource": "Invalid resource given to get helper"
+                "invalidResource": "Invalid resource given to get helper",
+                "apiRequired": {
+                    "message": "The \\{\\{#get\\}\\} helper requires your theme to have API access.",
+                    "context": "Please enable the v2 API via your theme's package.json file."
+                }
             },
             "has": {
                 "invalidAttribute": "Invalid or no attribute given to has helper"

core/test/unit/helpers/get_spec.js

@@ -45,9 +45,9 @@ describe('{{#get}} helper', function () {
             result.should.be.a.Function();
             result().should.be.an.Object().with.property(
                 'string',
-                '<script>console.error("The {{get}} helper is not available. ' +
+                '<script>console.error("The {{#get}} helper requires your theme to have API access. ' +
-                'The Public API flag must be enabled in labs if you wish to use the {{get}} helper. ' +
+                'Please enable the v2 API via your theme\'s package.json file. ' +
-                'See https://docs.ghost.org/faq/api-versioning/");</script>'
+                'See https://docs.ghost.org/api/handlebars-themes/packagejson/");</script>'
             );
 
             done();