@silexlabs/silex 3.0.0-alpha.100

package/src/ts/server/express.ts

@@ -0,0 +1,70 @@
+/*
+ * Silex website builder, free/libre no-code tool for makers.
+ * Copyright (c) 2023 lexoyo and Silex Labs foundation
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import express, { Application } from 'express'
+import bodyParser from 'body-parser'
+import compression from 'compression'
+import cookieParser from 'cookie-parser'
+import session from 'cookie-session'
+import cors from 'cors'
+
+import { ServerConfig } from './config'
+import { ServerEvent } from './events'
+
+export function create(config: ServerConfig): Application {
+  // Express app
+  const app = express()
+  app.set('config', config)
+
+  // CORS
+  const options = config.expressOptions
+  if (options.cors) {
+    console.info('> CORS are ENABLED:', options.cors)
+    app.use(cors({
+      origin: options.cors,
+    }))
+  }
+  // compress gzip when possible
+  app.use(compression() as any)
+
+  // cookie & session
+  app.use(bodyParser.json({ limit: options.jsonLimit }))
+  app.use(bodyParser.text({ limit: options.textLimit }))
+  app.use(bodyParser.urlencoded({ limit: options.urlencodedLimit }))
+  console.info('> Session name:', options.sessionName)
+  app.use(cookieParser() as any)
+  app.use(session({
+    name: options.sessionName,
+    secret: options.sessionSecret,
+  }) as any)
+  return app
+}
+
+export async function start(app: Application): Promise<Application> {
+  const config = app.get('config') as ServerConfig
+
+  // Plugins hook to create API routes
+  config.emit(ServerEvent.STARTUP_START, { app })
+
+  // Start server
+  return new Promise((resolve, reject) => {
+    app.listen(config.port, () => {
+      config.emit(ServerEvent.STARTUP_END, { app })
+      resolve(app)
+    })
+  })
+}

package/src/ts/server/index.ts

@@ -0,0 +1,100 @@
+/*
+ * Silex website builder, free/libre no-code tool for makers.
+ * Copyright (c) 2023 lexoyo and Silex Labs foundation
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import * as silexApp from './express'
+import api from './api/api'
+import { ServerConfig } from './config'
+import dotenv from 'dotenv'
+import { join } from 'path'
+
+// Expose API to calling app as function silex()
+export * from './expose'
+
+// Main app
+export default async function silex() {
+  // Load env vars from .env file if any
+  const curDirEnv = dotenv.config()
+  if (curDirEnv.error) {
+    if(curDirEnv.error['code'] === 'ENOENT') {
+      console.info('> No .env file found in current directory')
+    } else {
+      throw curDirEnv.error
+    }
+  } else {
+    console.info('> Env vars loaded from .env file')
+  }
+
+  // Load default env vars
+  // This will not override existing env vars
+  const DEFAULT_ENV_FILE = join(__dirname, '../../../.env.default')
+  const rootDirEnv = dotenv.config({ path: DEFAULT_ENV_FILE })
+  if (rootDirEnv.error) {
+    if(rootDirEnv.error['code'] === 'ENOENT') {
+      throw new Error(`\n\nFailed to load default env vars. File not found ${DEFAULT_ENV_FILE}\n\n`)
+    } else {
+      throw new Error(`\n\nFailed to load default env vars. Error in ${DEFAULT_ENV_FILE}: ${ rootDirEnv.error.message }\n\n`)
+    }
+  }
+  console.info('> Default env vars loaded')
+
+  // Get the default config object
+  const config = new ServerConfig()
+
+  // start silex
+  const app = silexApp.create(config)
+
+  // Serve the client config file
+  await config.addRoutes(app)
+
+  // Load the config files
+  await config.loadConfigFiles()
+
+  // Init the connectors in case no plugin adds them
+  await config.initDefaultConnectors()
+
+  // APIs
+  app.use('/api', api(config))
+
+  // Start the server
+  await silexApp.start(app)
+
+  // All good, server is ready
+  console.info(`
+I'm ready, listening to port ${config.port}
+  `)
+  if (config.debug) {
+    startLiverReload()
+  }
+}
+
+// livereload
+async function startLiverReload() {
+  // Load modules only when needed (they may not even be installed)
+  const { createServer } = await import('livereload')
+  const { resolve } = await import('path')
+  const dist = resolve(__dirname, '../../client')
+  const server = createServer({
+    delay: 0,
+  }, () => {
+    console.info(`\n> Debug mode\n> Live reload server is running.\n> Watching ${dist}`)
+  })
+  server.watch(dist)
+}
+
+if (require.main === module) {
+  silex()
+}

package/src/ts/server/jobs.test.ts

@@ -0,0 +1,75 @@
+/*
+ * Silex website builder, free/libre no-code tool for makers.
+ * Copyright (c) 2023 lexoyo and Silex Labs foundation
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import { JobData, JobStatus } from '../types'
+import { startJob, jobSuccess, jobError, getJob, killJob } from './jobs'
+import { expect, afterEach, it, describe } from '@jest/globals'
+
+let job: JobData | undefined
+afterEach(() => {
+  // Avoid memory leak
+  if(job) killJob(job)
+})
+
+describe('Job Module', () => {
+  it('should start a job', () => {
+    const {jobId} = startJob('Test job')
+    job = getJob(jobId)
+    expect(job).not.toBeNull()
+    if (job) {
+      expect(job.jobId).toEqual(jobId)
+      expect(job.status).toEqual(JobStatus.IN_PROGRESS)
+      expect(job.message).toEqual('Test job')
+      killJob(job)
+      expect(getJob(jobId)).toBeUndefined()
+    }
+  })
+
+  it('should end a job with success', () => {
+    const {jobId} = startJob('Test job')
+    const result = jobSuccess(jobId, 'Job completed successfully')
+    expect(result).toBeTruthy()
+    job = getJob(jobId)
+    expect(job).not.toBeNull()
+    if (job) {
+      expect(job.status).toEqual(JobStatus.SUCCESS)
+      expect(job.message).toEqual('Job completed successfully')
+    }
+  })
+
+  it('should end a job with error', () => {
+    const {jobId} = startJob('Test job')
+    const result = jobError(jobId, 'Job ended with error')
+    expect(result).toBeTruthy()
+    job = getJob(jobId)
+    expect(job).not.toBeNull()
+    if (job) {
+      expect(job.status).toEqual(JobStatus.ERROR)
+      expect(job.message).toEqual('Job ended with error')
+    }
+  })
+
+  it('should not find a job after ending', done => {
+    const {jobId} = startJob('Test job')
+    jobSuccess(jobId, 'Job completed successfully')
+    setTimeout(() => {
+      job = getJob(jobId)
+      expect(job).not.toBeUndefined()
+      done()
+    }, 1000)
+  })
+})

package/src/ts/server/jobs.ts

@@ -0,0 +1,87 @@
+/*
+ * Silex website builder, free/libre no-code tool for makers.
+ * Copyright (c) 2023 lexoyo and Silex Labs foundation
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+import { JobData, JobStatus, JobId } from '../types'
+
+// Delay after which the job is deleted from memory
+const TIME_TO_KEEP_AFTER_STOP = 60*10*1000 // 10 min
+
+// Store the jobs in memory
+const jobs = new Array<JobData>()
+
+// Key which will change on server restart
+const processKey = Math.ceil(Math.random() * 1000000)
+
+// Next id for the next job
+let nextJobId = 0
+
+// Create a new job
+export function startJob(message = ''): JobData {
+  const jobId = `${processKey}_${++nextJobId}`
+  const job: JobData = {
+    jobId,
+    status: JobStatus.IN_PROGRESS,
+    message: message
+  }
+  jobs.push(job)
+  return job
+}
+
+// Retriev a job if it exists
+export function getJob(id: JobId): JobData | undefined {
+  return jobs.find(job => job.jobId === id)
+}
+
+
+// End the job with success
+export function jobSuccess(id: JobId, message = ''): boolean {
+  return end(id, JobStatus.SUCCESS, message)
+}
+
+// End the job with error
+export function jobError(id: JobId, message = ''): boolean {
+  return end(id, JobStatus.ERROR, message)
+}
+
+// Remove a job from memory
+// This is also used in unit tests to avoid memory lea
+export function killJob(job: JobData) {
+  clearTimeout(job._timeout)
+  jobs.splice(jobs.findIndex(j => job.jobId === j.jobId), 1)
+}
+
+// End the job
+function end(id: JobId, status: JobStatus, message = ''): boolean {
+  const job = getJob(id)
+  if(job) {
+    job.status = status
+    if(message) job.message = message
+    job._timeout = setTimeout(() => killJob(job), TIME_TO_KEEP_AFTER_STOP)
+    return true
+  }
+  return false
+}
+
+// Type definition of the job manager
+export interface JobManager {
+  startJob: typeof startJob
+  jobSuccess: typeof jobSuccess
+  jobError: typeof jobError
+}
+
+// Export the job manager
+export const jobManager: JobManager = { startJob, jobSuccess, jobError }