martmullandGitHub
a6cc80eedd
This PR adds 2 columns handlerPath and handlerName in serverlessFunction
to locate the entrypoint of a serverless in a codebase
It adds the following decorators in twenty-sdk:
- ServerlessFunction
- DatabaseEventTrigger
- RouteTrigger
- CronTrigger
- ApplicationVariable
It still supports deprecated entity.manifest.jsonc
Overall code needs to be cleaned a little bit, but it should work
properly so you can try to test if the DEVX fits your needs
See updates in hello-world application
```typescript
import axios from 'axios';
import {
DatabaseEventTrigger,
ServerlessFunction,
RouteTrigger,
CronTrigger,
ApplicationVariable,
} from 'twenty-sdk';
@ApplicationVariable({
universalIdentifier: 'dedc53eb-9c12-4fe2-ba86-4a2add19d305',
key: 'TWENTY_API_KEY',
description: 'Twenty API Key',
isSecret: true,
})
@DatabaseEventTrigger({
universalIdentifier: '203f1df3-4a82-4d06-a001-b8cf22a31156',
eventName: 'person.created',
})
@RouteTrigger({
universalIdentifier: 'c9f84c8d-b26d-40d1-95dd-4f834ae5a2c6',
path: '/post-card/create',
httpMethod: 'GET',
isAuthRequired: false,
})
@CronTrigger({
universalIdentifier: 'dd802808-0695-49e1-98c9-d5c9e2704ce2',
pattern: '0 0 1 1 *', // Every year 1st of January
})
@ServerlessFunction({
universalIdentifier: 'e56d363b-0bdc-4d8a-a393-6f0d1c75bdcf',
})
class CreateNewPostCard {
main = async (params: { recipient: string }): Promise<string> => {
const { recipient } = params;
const options = {
method: 'POST',
url: 'http://localhost:3000/rest/postCards',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${process.env.TWENTY_API_KEY}`,
},
data: { name: recipient ?? 'Unknown' },
};
try {
const { data } = await axios.request(options);
console.log(`New post card to "${recipient}" created`);
return data;
} catch (error) {
console.error(error);
throw error;
}
};
}
export const createNewPostCardHandler = new CreateNewPostCard().main;
```
### [edit] V2
After the v1 proposal, I see that using a class method to define the
serverless function handler is pretty confusing. Lets leave
serverlessFunction configuration decorators on the class, but move the
handler like before. Here is the v2 hello-world serverless function:
```typescript
import axios from 'axios';
import {
DatabaseEventTrigger,
ServerlessFunction,
RouteTrigger,
CronTrigger,
ApplicationVariable,
} from 'twenty-sdk';
@ApplicationVariable({
universalIdentifier: 'dedc53eb-9c12-4fe2-ba86-4a2add19d305',
key: 'TWENTY_API_KEY',
description: 'Twenty API Key',
isSecret: true,
})
@DatabaseEventTrigger({
universalIdentifier: '203f1df3-4a82-4d06-a001-b8cf22a31156',
eventName: 'person.created',
})
@RouteTrigger({
universalIdentifier: 'c9f84c8d-b26d-40d1-95dd-4f834ae5a2c6',
path: '/post-card/create',
httpMethod: 'GET',
isAuthRequired: false,
})
@CronTrigger({
universalIdentifier: 'dd802808-0695-49e1-98c9-d5c9e2704ce2',
pattern: '0 0 1 1 *', // Every year 1st of January
})
@ServerlessFunction({
universalIdentifier: 'e56d363b-0bdc-4d8a-a393-6f0d1c75bdcf',
})
export class ServerlessFunctionDefinition {}
export const main = async (params: { recipient: string }): Promise<string> => {
const { recipient } = params;
const options = {
method: 'POST',
url: 'http://localhost:3000/rest/postCards',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${process.env.TWENTY_API_KEY}`,
},
data: { name: recipient ?? 'Unknown' },
};
try {
const { data } = await axios.request(options);
console.log(`New post card to "${recipient}" created`);
return data;
} catch (error) {
console.error(error);
throw error;
}
};
```
### [edit] V3
After the v2 proposal, we don't really like decorators on empty classes.
We decided to go with a Vercel approach with a config constant
```typescript
import axios from 'axios';
import { ServerlessFunctionConfig } from 'twenty-sdk';
export const main = async (params: { recipient: string }): Promise<string> => {
const { recipient } = params;
const options = {
method: 'POST',
url: 'http://localhost:3000/rest/postCards',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${process.env.TWENTY_API_KEY}`,
},
data: { name: recipient ?? 'Unknown' },
};
try {
const { data } = await axios.request(options);
console.log(`New post card to "${recipient}" created`);
return data;
} catch (error) {
console.error(error);
throw error;
}
};
export const config: ServerlessFunctionConfig = {
universalIdentifier: 'e56d363b-0bdc-4d8a-a393-6f0d1c75bdcf',
routeTriggers: [
{
universalIdentifier: 'c9f84c8d-b26d-40d1-95dd-4f834ae5a2c6',
path: '/post-card/create',
httpMethod: 'GET',
isAuthRequired: false,
}
],
cronTriggers: [
{
universalIdentifier: 'dd802808-0695-49e1-98c9-d5c9e2704ce2',
pattern: '0 0 1 1 *', // Every year 1st of January
}
],
databaseEventTriggers: [
{
universalIdentifier: '203f1df3-4a82-4d06-a001-b8cf22a31156',
eventName: 'person.created',
}
]
}
```
113 lines
2.6 KiB
TypeScript
113 lines
2.6 KiB
TypeScript
import { randomUUID } from 'crypto';
|
|
import { getSchemaUrls } from './schema-validator';
|
|
import * as fs from 'fs-extra';
|
|
import { BASE_APPLICATION_PROJECT_PATH } from '../constants/constants-path';
|
|
import { writeJsoncFile } from '../utils/jsonc-parser';
|
|
import { join } from 'path';
|
|
import path from 'path';
|
|
import { v4 } from 'uuid';
|
|
|
|
export const copyBaseApplicationProject = async ({
|
|
appName,
|
|
appDisplayName,
|
|
appDescription,
|
|
appDirectory,
|
|
}: {
|
|
appName: string;
|
|
appDisplayName: string;
|
|
appDescription: string;
|
|
appDirectory: string;
|
|
}) => {
|
|
await fs.copy(BASE_APPLICATION_PROJECT_PATH, appDirectory);
|
|
|
|
await fs.rename(
|
|
join(appDirectory, 'gitignore'),
|
|
join(appDirectory, '.gitignore'),
|
|
);
|
|
|
|
await fs.copy(join(appDirectory, '.env.example'), join(appDirectory, '.env'));
|
|
|
|
await createBasePackageJson({
|
|
appName,
|
|
appDirectory,
|
|
});
|
|
|
|
await createApplicationConfig({
|
|
displayName: appDisplayName,
|
|
description: appDescription,
|
|
appDirectory,
|
|
});
|
|
|
|
await createReadmeContent({
|
|
displayName: appDisplayName,
|
|
appDescription,
|
|
appDirectory,
|
|
});
|
|
};
|
|
|
|
const createApplicationConfig = async ({
|
|
displayName,
|
|
description,
|
|
appDirectory,
|
|
}: {
|
|
displayName: string;
|
|
description?: string;
|
|
appDirectory: string;
|
|
}) => {
|
|
const content = `import { type ApplicationConfig } from 'twenty-sdk/application';
|
|
|
|
const config: ApplicationConfig = {
|
|
universalIdentifier: '${v4()}',
|
|
displayName: '${displayName}',
|
|
description: '${description ?? ''}',
|
|
};
|
|
|
|
export default config;
|
|
`;
|
|
|
|
await fs.writeFile(path.join(appDirectory, 'application.config.ts'), content);
|
|
};
|
|
|
|
const createBasePackageJson = async ({
|
|
appName,
|
|
appDirectory,
|
|
}: {
|
|
appName: string;
|
|
appDirectory: string;
|
|
}) => {
|
|
const base = JSON.parse(await readBaseApplicationProjectFile('package.json'));
|
|
|
|
const schemas = getSchemaUrls();
|
|
|
|
base['$schema'] = schemas.appManifest;
|
|
base['universalIdentifier'] = randomUUID();
|
|
base['name'] = appName;
|
|
|
|
await writeJsoncFile(join(appDirectory, 'package.json'), base);
|
|
};
|
|
|
|
const createReadmeContent = async ({
|
|
displayName,
|
|
appDescription,
|
|
appDirectory,
|
|
}: {
|
|
displayName: string;
|
|
appDescription: string;
|
|
appDirectory: string;
|
|
}) => {
|
|
let readmeContent = await readBaseApplicationProjectFile('README.md');
|
|
|
|
readmeContent = readmeContent.replace(/\{title}/g, displayName);
|
|
|
|
readmeContent = readmeContent.replace(/\{description}/g, appDescription);
|
|
|
|
await fs.writeFile(path.join(appDirectory, 'README.md'), readmeContent);
|
|
};
|
|
|
|
const readBaseApplicationProjectFile = async (fileName: string) => {
|
|
return await fs.readFile(
|
|
join(BASE_APPLICATION_PROJECT_PATH, fileName),
|
|
'utf-8',
|
|
);
|
|
};
|