feat: Update example to Parse Server 8

.github/workflows/ci.yml

@@ -8,28 +8,39 @@ on:
       - '**'
   workflow_dispatch:
 jobs:
-  test:
+  lint:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [18, 20, 22]
-      fail-fast: false
-    name: Test Node ${{ matrix.node-version }}
+    name: Lint
     steps:
-    - name: Fix usage of insecure GitHub protocol
-      run: sudo git config --system url."https://github".insteadOf "git://github"
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - name: Install Dependancies
-      run: npm install
-    - name: Check Linting
-      run: npm run lint
-    - name: Run Tests
-      run: npm run test
+      - name: Fix usage of insecure GitHub protocol
+        run: sudo git config --system url."https://github".insteadOf "git://github"
+      - uses: actions/checkout@v3
+      - name: Use Node.js 22
+        uses: actions/setup-node@v3
+        with:
+          node-version: 22
+          cache: 'npm'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Check Linting
+        run: npm run lint
+
+  tests:
+    runs-on: ubuntu-latest
+    name: Tests
+    steps:
+      - name: Fix usage of insecure GitHub protocol
+        run: sudo git config --system url."https://github".insteadOf "git://github"
+      - uses: actions/checkout@v3
+      - name: Use Node.js 22
+        uses: actions/setup-node@v3
+        with:
+          node-version: 22
+          cache: 'npm'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Run Tests
+        run: npm test
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
+  cancel-in-progress: true

README.md

@@ -57,9 +57,14 @@ These scripts can help you to develop your app for Parse Server:
 * `npm run lint` will check the linting of your cloud code, tests and `index.js`, as defined in `.eslintrc.json`.
 * `npm run lint-fix` will attempt fix the linting of your cloud code, tests and `index.js`.
 * `npm run prettier` will help improve the formatting and layout of your cloud code, tests and `index.js`, as defined in `.prettierrc`.
-* `npm run test` will run any tests that are written in `/spec`.
+* `npm test` will run all tests
 * `npm run coverage` will run tests and check coverage. Output is available in the `/coverage` folder.
 
+## Configuration
+
+Configuration is located in `config.js`.
+
+
 # Remote Deployment
 
 ## Heroku

cloud/functions.js

@@ -3,12 +3,12 @@ Parse.Cloud.define('hello', req => {
   return 'Hi';
 });
 
-Parse.Cloud.define('asyncFunction', async req => {
+Parse.Cloud.define('helloAsyncFunction', async req => {
   await new Promise(resolve => setTimeout(resolve, 1000));
   req.log.info(req);
   return 'Hi async';
 });
 
-Parse.Cloud.beforeSave('Test', () => {
+Parse.Cloud.beforeSave('TestObject', () => {
   throw new Parse.Error(9001, 'Saving test objects is not available.');
 });

cloud/main.js

@@ -1,2 +1,4 @@
 // It is best practise to organize your cloud functions group into their own file. You can then import them in your main.js.
-await import('./functions.js');
+await Promise.all([
+  import('./functions.js')
+]);

cloud/schema.js

@@ -0,0 +1,15 @@
+export const schemaDefinitions = [{
+  className: "TestObject",
+  fields: {
+    beforeSave: { type: "Boolean", defaultValue: false },
+    additionalData: { type: "String" },
+  },
+  classLevelPermissions: {
+    find: { "*": true },
+    count: { "*": true },
+    get: { "*": true },
+    update: { "*": true },
+    create: { "*": true },
+    delete: { "*": true },
+  },
+}];

config.js

@@ -0,0 +1,18 @@
+import { schemaDefinitions } from "./cloud/schema.js";
+export const config = {
+  databaseURI: process.env.DATABASE_URI || process.env.MONGODB_URI || 'mongodb://localhost:27017/dev',
+  cloud: process.env.CLOUD_CODE_MAIN || './cloud/main.js',
+  appId: process.env.APP_ID || 'myAppId',
+  masterKey: process.env.MASTER_KEY || '', //Add your master key here. Keep it secret!
+  serverURL: process.env.SERVER_URL || 'http://localhost:1337/parse', // Don't forget to change to https if needed
+  liveQuery: {
+    classNames: ['Posts', 'Comments'], // List of classes to support for query subscriptions
+  },
+  schema: {
+    definitions: schemaDefinitions,
+    lockSchemas: true,
+    strict: true,
+    recreateModifiedFields: false,
+    deleteExtraFields: false,
+  },
+};

index.js

@@ -4,38 +4,19 @@
 import express from 'express';
 import { ParseServer } from 'parse-server';
 import path from 'path';
-const __dirname = path.resolve();
 import http from 'http';
-
-export const config = {
-  databaseURI:
-    process.env.DATABASE_URI || process.env.MONGODB_URI || 'mongodb://localhost:27017/dev',
-  cloud: process.env.CLOUD_CODE_MAIN || __dirname + '/cloud/main.js',
-  appId: process.env.APP_ID || 'myAppId',
-  masterKey: process.env.MASTER_KEY || '', //Add your master key here. Keep it secret!
-  serverURL: process.env.SERVER_URL || 'http://localhost:1337/parse', // Don't forget to change to https if needed
-  liveQuery: {
-    classNames: ['Posts', 'Comments'], // List of classes to support for query subscriptions
-  },
-};
-// Client-keys like the javascript key or the .NET key are not necessary with parse-server
-// If you wish you require them, you can set them as options in the initialization above:
-// javascriptKey, restAPIKey, dotNetKey, clientKey
-
-export const app = express();
-
-app.set('trust proxy', true);
+import { config } from './config.js';
+const __dirname = path.resolve();
+const app = express();
 
 // Serve static assets from the /public folder
 app.use('/public', express.static(path.join(__dirname, '/public')));
 
 // Serve the Parse API on the /parse URL prefix
-if (!process.env.TESTING) {
-  const mountPath = process.env.PARSE_MOUNT || '/parse';
-  const server = new ParseServer(config);
-  await server.start();
-  app.use(mountPath, server.app);
-}
+const mountPath = process.env.PARSE_MOUNT || '/parse';
+const server = new ParseServer(config);
+await server.start();
+app.use(mountPath, server.app);
 
 // Parse Server plays nicely with the rest of your web routes
 app.get('/', function (req, res) {
@@ -48,12 +29,11 @@ app.get('/test', function (req, res) {
   res.sendFile(path.join(__dirname, '/public/test.html'));
 });
 
-if (!process.env.TESTING) {
-  const port = process.env.PORT || 1337;
-  const httpServer = http.createServer(app);
-  httpServer.listen(port, function () {
-    console.log('parse-server-example running on port ' + port + '.');
-  });
-  // This will enable the Live Query real-time server
-  await ParseServer.createLiveQueryServer(httpServer);
-}
+const port = process.env.PORT || 1337;
+const httpServer = http.createServer(app);
+httpServer.listen(port, function () {
+  console.log('parse-server-example running on port ' + port + '.');
+});
+// This will enable the Live Query real-time server
+await ParseServer.createLiveQueryServer(httpServer);
+console.log(`Visit http://localhost:${port}/test to check the Parse Server`);