feat!: remove hosted app action functionality from app-scripts

BREAKING CHANGE: removes the ability to create hosted app actions from app-scripts

Author: t-col

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

@@ -1,17 +1,6 @@
 import { Definition } from './definition-api';
 import { Organization } from './organization-api';
 
-export interface FunctionAppAction {
-  id: string;
-  name: string;
-  description: string;
-  category: 'Custom';
-  type: 'function';
-  path: string;
-  allowNetworks?: string[];
-  entryFile?: string;
-}
-
 export interface ContentfulFunction {
   id: string;
   name: string;
@@ -84,7 +73,6 @@ export interface UploadSettings {
   skipActivation?: boolean;
   userAgentApplication?: string;
   host?: string;
-  actions?: FunctionAppAction[];
   functions?: ContentfulFunction[];
 }
 

packages/contentful--app-scripts/src/upload/build-upload-settings.test.ts

@@ -10,12 +10,12 @@ import * as utilsModule from '../utils';
 describe('buildAppUploadSettings', () => {
   let promptStub;
   let getAppInfoStub;
-  let getEntityFromManifestStub;
+  let getFunctionsFromManifestStub;
 
   beforeEach(() => {
     promptStub = sinon.stub(inquirer, 'prompt');
     getAppInfoStub = sinon.stub(getAppInfoModule, 'getAppInfo');
-    getEntityFromManifestStub = sinon.stub(utilsModule, 'getEntityFromManifest');
+    getFunctionsFromManifestStub = sinon.stub(utilsModule, 'getFunctionsFromManifest');
   });
 
   afterEach(() => {
@@ -39,16 +39,14 @@ describe('buildAppUploadSettings', () => {
 
     getAppInfoStub.resolves({ appId: '123', appName: 'Test App' });
 
-    getEntityFromManifestStub.withArgs('actions').returns('actionsManifest');
-    getEntityFromManifestStub.withArgs('functions').returns('functionsManifest');
+    getFunctionsFromManifestStub.returns('functionsManifest');
 
     const result = await buildAppUploadSettings(options);
 
     assert.strictEqual(result.host, 'api.contentful.com', 'Protocol should be stripped from host');
     assert.strictEqual(result.bundleDirectory, './custom-build');
     assert.strictEqual(result.comment, 'Test comment');
     assert.strictEqual(result.skipActivation, false); // activateBundle is true, so skipActivation should be false
-    assert.strictEqual(result.actions, 'actionsManifest');
     assert.strictEqual(result.functions, 'functionsManifest');
   });
   }
@@ -64,8 +62,7 @@ describe('buildAppUploadSettings', () => {
 
     promptStub.resolves(prompts);
     getAppInfoStub.resolves({ appId: '123', appName: 'Test App' });
-    getEntityFromManifestStub.withArgs('actions').returns('actionsManifest');
-    getEntityFromManifestStub.withArgs('functions').returns('functionsManifest');
+    getFunctionsFromManifestStub.returns('functionsManifest');
 
     const result = await buildAppUploadSettings(options);
 
@@ -82,8 +79,7 @@ describe('buildAppUploadSettings', () => {
 
     promptStub.resolves({});
     getAppInfoStub.resolves({ appId: '123', appName: 'Test App' });
-    getEntityFromManifestStub.withArgs('actions').returns('actionsManifest');
-    getEntityFromManifestStub.withArgs('functions').returns('functionsManifest');
+    getFunctionsFromManifestStub.returns('functionsManifest');
 
     const result = await buildAppUploadSettings(options);
 
@@ -99,8 +95,7 @@ describe('buildAppUploadSettings', () => {
 
     promptStub.resolves(prompts);
     getAppInfoStub.resolves({ appId: '123', appName: 'Test App' });
-    getEntityFromManifestStub.withArgs('actions').returns('actionsManifest');
-    getEntityFromManifestStub.withArgs('functions').returns('functionsManifest');
+    getFunctionsFromManifestStub.returns('functionsManifest');
 
     const result = await buildAppUploadSettings(options);
 

packages/contentful--app-scripts/src/upload/build-upload-settings.ts

@@ -1,12 +1,11 @@
 import { prompt } from 'inquirer';
 import { getAppInfo } from '../get-app-info';
-import { getEntityFromManifest } from '../utils';
+import { getFunctionsFromManifest } from '../utils';
 import { DEFAULT_CONTENTFUL_API_HOST } from '../constants';
 import { UploadOptions, UploadSettings } from '../types';
 
 export async function buildAppUploadSettings(options: UploadOptions): Promise<UploadSettings> {
-  const actionsManifest = getEntityFromManifest('actions');
-  const functionManifest = getEntityFromManifest('functions');
+  const functionManifest = getFunctionsFromManifest();
   const prompts = [];
   const { bundleDir, comment, skipActivation, host } = options;
 
@@ -50,7 +49,6 @@ export async function buildAppUploadSettings(options: UploadOptions): Promise<Up
     skipActivation: skipActivation === undefined ? !activateBundle : skipActivation,
     comment,
     host: hostValue,
-    actions: actionsManifest,
     functions: functionManifest,
     ...appUploadSettings,
     ...appInfo,

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

@@ -7,7 +7,7 @@ import { createAppUpload } from './create-app-upload';
 import { UploadSettings } from '../types';
 
 export async function createAppBundleFromUpload(settings: UploadSettings, appUploadId: string) {
-  const { accessToken, host, userAgentApplication, comment, actions, functions } = settings;
+  const { accessToken, host, userAgentApplication, comment, functions } = settings;
   const clientSpinner = ora('Verifying your upload...').start();
   const client = createClient({
     accessToken,
@@ -24,7 +24,6 @@ export async function createAppBundleFromUpload(settings: UploadSettings, appUpl
     appBundle = await appDefinition.createAppBundle({
       appUploadId,
       comment: comment && comment.length > 0 ? comment : undefined,
-      actions,
       functions,
     });
   } catch (err: any) {

packages/contentful--app-scripts/src/upload/get-upload-settings-args.ts

@@ -2,7 +2,7 @@ import chalk from 'chalk';
 import ora from 'ora';
 import { getAppInfo } from '../get-app-info';
 import { validateArguments } from '../validate-arguments';
-import { getEntityFromManifest } from '../utils';
+import { getFunctionsFromManifest } from '../utils';
 import { UploadOptions, UploadSettings } from '../types';
 
 const requiredOptions = {
@@ -14,8 +14,7 @@ const requiredOptions = {
 
 export async function getUploadSettingsArgs(options: UploadOptions): Promise<UploadSettings> {
   const validateSpinner = ora('Validating your input...').start();
-  const actionsManifest = getEntityFromManifest('actions');
-  const functionManifest = getEntityFromManifest('functions');
+  const functionManifest = getFunctionsFromManifest();
   const { bundleDir, comment, skipActivation, host, userAgentApplication } = options;
 
   try {
@@ -28,7 +27,6 @@ export async function getUploadSettingsArgs(options: UploadOptions): Promise<Upl
       comment,
       host,
       userAgentApplication,
-      actions: actionsManifest,
       functions: functionManifest,
     };
   } catch (err: any) {

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

@@ -26,7 +26,7 @@ describe('validateBundle', () => {
   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'>;
+    } as Pick<UploadSettings, 'functions'>;
     const fsstub = {
       readdirSync: () => ['functions', 'functions/myFunc.js'],
     };
@@ -60,7 +60,7 @@ describe('validateBundle', () => {
         { id: 'myFunc', path: 'functions/myFunc.js' },
         { id: 'myOtherFunc', path: 'functions/myOtherFunc.js' },
       ],
-    } as Pick<UploadSettings, 'functions' | 'actions'>;
+    } as Pick<UploadSettings, 'functions'>;
     const fsstub = {
       readdirSync: () => ['index.html', 'functions', 'functions/myFunc.js'],
       readFileSync: () => '<html><script src="./relative/path"></script></html>',
@@ -75,26 +75,4 @@ describe('validateBundle', () => {
       );
     }
   });
-
-  it('throws when there is no entry point for a function defined in the contentful-app-manifest.json', () => {
-    const mockedSettings = {
-      actions: [
-        { id: 'myAction', path: 'actions/myAction.js' },
-        { id: 'myOtherAction', path: 'actions/myOtherAction.js' },
-      ],
-    } as Pick<UploadSettings, 'functions' | 'actions'>;
-    const fsstub = {
-      readdirSync: () => ['index.html', 'actions', 'actions/myAction.js'],
-      readFileSync: () => '<html><script src="./relative/path"></script></html>',
-    };
-    const { validateBundle } = proxyquire('./validate-bundle', { fs: fsstub });
-    try {
-      validateBundle('build', mockedSettings);
-    } catch (e: any) {
-      assert.strictEqual(
-        e.message,
-        'Action "myOtherAction" is missing its entry file at "build/actions/myOtherAction.js".'
-      );
-    }
-  });
 });

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

@@ -14,13 +14,13 @@ const fileContainsAbsolutePath = (fileContent: string) => {
 
 export const validateBundle = (
   path: string,
-  { functions, actions }: Pick<UploadSettings, 'functions' | 'actions'>
+  { functions }: Pick<UploadSettings, 'functions'>
 ) => {
   const buildFolder = Path.join('./', path);
   const files = fs.readdirSync(buildFolder, { recursive: true, encoding: 'utf-8' });
   const entry = getEntryFile(files);
 
-  if (!entry && !functions && !actions) {
+  if (!entry && !functions) {
     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).'
     );
@@ -51,16 +51,4 @@ export const validateBundle = (
       );
     }
   }
-
-  if (actions) {
-    const actionWithoutEntryFile = actions.find(({ path }) => !files.includes(path));
-    if (actionWithoutEntryFile) {
-      throw new Error(
-        `Action "${actionWithoutEntryFile.id}" is missing its entry file at "${Path.join(
-          buildFolder,
-          actionWithoutEntryFile.path
-        )}".`
-      );
-    }
-  }
 };

packages/contentful--app-scripts/src/upsert-actions/validation.ts

@@ -1,5 +1,5 @@
 import z from 'zod';
-import { CreateAppActionOptions } from './types';
+import { CreateAppActionOptions as UpsertAppActionOptions } from './types';
 import { ID_REGEX } from '../utils';
 
 const parametersSchema = z
@@ -26,7 +26,7 @@ export const validateId = (id: string) => {
 
 export function validateActionsManifest(
 	manifest: Record<string, any>,
-): CreateAppActionOptions['actions'] {
+): UpsertAppActionOptions['actions'] {
 	if (!manifest.actions) {
 		throw new Error('Invalid App Action manifest: missing "actions" field');
 	}