feat: throw a warning if require-adobe-auth is set for a non-web acti…

…on (#171)


---------

Co-authored-by: Shazron Abdullah <36107+shazron@users.noreply.github.com>

src/utils.js

@@ -1088,10 +1088,16 @@ function rewriteActionsWithAdobeAuthAnnotation (packages, deploymentPackages) {
         const isWeb = checkWebFlags(thisAction.web)['web-export']
         const isRaw = checkWebFlags(thisAction.web)['raw-http'] || checkWebFlags(thisAction['web-export'])['raw-http']
 
-        // check if the annotation is defined AND the action is a web action
-        if ((isWeb || isWebExport) && thisAction.annotations && thisAction.annotations[ADOBE_AUTH_ANNOTATION]) {
+        // check if the annotation is defined
+        if (thisAction.annotations?.[ADOBE_AUTH_ANNOTATION]) {
           aioLogger.debug(`found annotation '${ADOBE_AUTH_ANNOTATION}' in action '${key}/${actionName}', cli env = ${env}`)
 
+          // check if the action is a web action
+          if (!(isWeb || isWebExport)) {
+            aioLogger.warn(`The action '${key}/${actionName}' is not a web action, the annotation '${ADOBE_AUTH_ANNOTATION}' will be ignored.`)
+            return
+          }
+
           // 1. rename the action
           const renamedAction = REWRITE_ACTION_PREFIX + actionName
           /* istanbul ignore if */

test/utils.test.js

@@ -987,6 +987,8 @@ describe('processPackage', () => {
     let packagesCopy = cloneDeep(basicPackage)
     delete packagesCopy.pkg1.actions.theaction.web
     res = utils.processPackage(packagesCopy, {}, {}, {}, false, { apihost: 'https://adobeioruntime.net' })
+    const loggerSpy = jest.spyOn(aioLogger, 'warn')
+    expect(loggerSpy).toHaveBeenLastCalledWith('The action \'pkg1/theaction\' is not a web action, the annotation \'require-adobe-auth\' will be ignored.')
     expect(res).toEqual({
       actions: [{
         name: 'pkg1/theaction',