feat: enable frontendless Function uploads (#2223)

* refactor: pin node to v20

* feat: add support for more function templates

* feat: add support for all available function event types

* feat: only validate index.html files when they exist, or when no functions are uploaded

* refactor: don't include examples as templates

Author: t-col

.nvmrc

@@ -1 +1 @@
-lts/*
+v20

packages/contentful--app-scripts/src/upload/validate-bundle.test.ts

@@ -11,18 +11,28 @@ describe('validateBundle', () => {
     (console.warn as SinonStub).restore();
   });
 
-  it('throws when there is no index.html', () => {
+  it('throws when there is no index.html & no functions or actions', () => {
     const fsstub = { readdirSync: () => [] };
     const { validateBundle } = proxyquire('./validate-bundle', { fs: fsstub });
     try {
       validateBundle('build', {});
     } catch (e: any) {
       assert.strictEqual(
         e.message,
-        'Make sure your bundle includes a valid index.html file in its root folder.'
+        'Ensure your bundle includes a valid index.html file in its root folder, or a valid Contentful Function entrypoint (defined in your contentful-app-manifest.json file).'
       );
     }
   });
+  it('does not throw when there is no index.html but a function is defined', () => {
+    const mockedSettings = {
+      functions: [{ id: 'myFunc', path: 'functions/myFunc.js' }],
+    } as Pick<UploadSettings, 'functions' | 'actions'>;
+    const fsstub = {
+      readdirSync: () => ['functions', 'functions/myFunc.js'],
+    };
+    const { validateBundle } = proxyquire('./validate-bundle', { fs: fsstub });
+    validateBundle('build', mockedSettings);
+  });
 
   it('warns when the index.html contains an absolute path', () => {
     const fsstub = {

packages/contentful--app-scripts/src/upload/validate-bundle.ts

@@ -20,20 +20,24 @@ export const validateBundle = (
   const files = fs.readdirSync(buildFolder, { recursive: true, encoding: 'utf-8' });
   const entry = getEntryFile(files);
 
-  if (!entry) {
-    throw new Error('Make sure your bundle includes a valid index.html file in its root folder.');
+  if (!entry && !functions && !actions) {
+    throw new Error(
+      'Ensure your bundle includes a valid index.html file in its root folder, or a valid Contentful Function entrypoint (defined in your contentful-app-manifest.json file).'
+    );
   }
 
-  const entryFile = fs.readFileSync(Path.join(buildFolder, entry), { encoding: 'utf8' });
+  if (entry) {
+    const entryFile = fs.readFileSync(Path.join(buildFolder, entry), { encoding: 'utf8' });
 
-  if (fileContainsAbsolutePath(entryFile)) {
-    console.log('----------------------------');
-    console.warn(
-      `${chalk.red(
-        'Warning:'
-      )} This bundle uses absolute paths. Please use relative paths instead for correct rendering. See more details here https://www.contentful.com/developers/docs/extensibility/app-framework/app-bundle/#limitations`
-    );
-    console.log('----------------------------');
+    if (fileContainsAbsolutePath(entryFile)) {
+      console.log('----------------------------');
+      console.warn(
+        `${chalk.red(
+          'Warning:'
+        )} This bundle uses absolute paths. Please use relative paths instead for correct rendering. See more details here https://www.contentful.com/developers/docs/extensibility/app-framework/app-bundle/#limitations`
+      );
+      console.log('----------------------------');
+    }
   }
 
   if (functions) {

packages/contentful--app-scripts/src/utils.ts

@@ -9,15 +9,15 @@ import { ContentfulFunction, FunctionAppAction } from './types';
 const DEFAULT_MANIFEST_PATH = './contentful-app-manifest.json';
 
 const functionEvents = {
+  appActionCall: 'appaction.call',
+  appEventFilter: 'appevent.filter',
+  appEventHandler: 'appevent.handler',
+  appEventTransformation: 'appevent.transformation',
   fieldMappingEvent: 'graphql.field.mapping',
   resourceTypeMappingEvent: 'graphql.resourcetype.mapping',
   queryEvent: 'graphql.query',
   resourceLinksSearchEvent: 'resources.search',
-  resourceLinksLookupEvent: 'resources.lookup',
-  appEventFilter: 'appevent.filter',
-  appEventHandler: 'appevent.handler',
-  appEventTransformation: 'appevent.transformation',
-  appActionCall: 'appaction.call',
+  resourceLinksLookupEvent: 'resources.lookup'
 };
 
 export const throwValidationException = (subject: string, message?: string, details?: string) => {
@@ -163,9 +163,7 @@ export function getEntityFromManifest<Type extends 'actions' | 'functions'>(
       }
       if (hasInvalidEvent) {
         console.log(
-          `${chalk.red(
-            'Error:'
-          )} Invalid events ${hasInvalidEvent} found in the accepts array for ${type} "${
+          `${chalk.red('Error:')} Invalid events found in the accepts array for ${type} "${
             item.name
           }".`
         );

packages/contentful--create-contentful-app/src/includeFunction.ts

@@ -12,10 +12,11 @@ const addBuildCommand = getAddBuildCommandFn({
 });
 
 const VALID_FUNCTION_TEMPLATES_DIRS = [
-  'external-references',
   'appevent-filter',
   'appevent-handler',
   'appevent-transformation',
+  'external-references',
+  'comment-bot',
 ];
 
 function functionTemplateFromName(functionName: string) {