Fixed revisions table losing originalIndex when article was deleted

I've also included a migration file in the tools directory

Dockerfile

@@ -1,9 +1,9 @@
 
-FROM node:15
+FROM node:16
 WORKDIR "/app"
 COPY package*.json ./
-COPY . /app
 RUN npm install --production
+COPY . /app
 EXPOSE 3100
 USER node
 ENTRYPOINT ["bash", "-c"]

README.md

@@ -6,10 +6,10 @@ An API centric news server. Uses Sequelize and mariaDB by default.
 
 There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker-compose up --build` - run `node configure-script.js` to generate docker-compose.yml and startup.sql.
 
-To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are 10 minutes):
+To generate an authorization token, use [auth-server](https://github.com/krgamestudios/auth-server). A public-facing development auth-server is available here (tokens are valid for 10 minutes):
 
 ```
-POST https://dev-auth.eggtrainer.com/auth/login HTTP/1.1
+POST https://dev-auth.krgamestudios.com/auth/login HTTP/1.1
 Content-Type: application/json
 
 {
@@ -25,13 +25,21 @@ Content-Type: application/json
 //NOTE: you can add a "limit" query parameter to change the default limit
 GET /news?limit=10
 
-//get latest news, up to a default limit, or specify the index "id"
+
+###
+
+
+//DOCS: get latest news, up to a default limit, or specify the index "id"
 GET /news/:id
 
-//get the news starting from the beginning, up to a default limit, or specify the index "id"
+
+###
+
+
+//DOCS: get the news starting from the beginning, up to a default limit, or specify the index "id"
 GET /news/archive/:id
 
-//result (if only a single article is specified, returns just that article rather than an array):
+//DOCS: result (if only a single article is specified, returns just that article rather than an array):
 [
 	{
 		"index": index,			//absolute index of the result
@@ -45,13 +53,21 @@ GET /news/archive/:id
 	...
 ]
 
-//get the latest metadata, up to a default limit, or specify the index "id"
+
+###
+
+
+//DOCS: get the latest metadata, up to a default limit, or specify the index "id"
 GET /news/metadata/:id
 
-//get the metadata starting from the beginning, up to a default limit, or specify the index "id"
+
+###
+
+
+//DOCS: get the metadata starting from the beginning, up to a default limit, or specify the index "id"
 GET /news/archive/metadata/:id
 
-//result (if only a single article is specified, returns just that article rather than an array):
+//DOCS: result (if only a single article is specified, returns just that article rather than an array):
 [
 	{
 		"index": index,			//absolute index of the result
@@ -64,38 +80,51 @@ GET /news/archive/metadata/:id
 	...
 ]
 
-//send a formatted JSON object, returns new index on success, or error on failure
+
+###
+
+
+//DOCS: send a formatted JSON object, returns new index on success, or error on failure
 POST /news
 Authorization: Bearer XXX
 
-//arguments:
 {
 	"title": title		//title of the article
 	"author": author	//author of the article
 	"body": body		//body of the article
 }
 
-//result (status 200 on success, otherwise an error status):
+//DOCS: result (status 200 on success, otherwise an error status):
 {
 	"index": index		//new index of the article
 }
 
-//similar to `POST /news`, but allows overwriting an existing article
+
+###
+
+
+//DOCS: similar to `POST /news`, but allows overwriting an existing article
 PATCH /news/:id
 Authorization: Bearer XXX
 
-//arguments:
 {
 	"title": title		//title of the article, optional
 	"author": author	//author of the article, optional
 	"body": body		//body of the article, optional
 }
 
-result: status 200 on success, otherwise an error status
+//DOCS: result: status 200 on success, otherwise an error status
 
-//remove an article from the news feed
+
+###
+
+
+//DOCS: remove an article from the news feed
 DELETE /news/:id
 Authorization: Bearer XXX
 
-//result: status 200 on success, otherwise an error status
+//DOCS: result: status 200 on success, otherwise an error status
+
+
+###
 ```

configure-script.js

@@ -109,7 +109,7 @@ networks:
 `;
 
 	const dockerfile = `
-FROM node:15
+FROM node:16
 WORKDIR "/app"
 COPY package*.json ./
 RUN npm install --production

package-lock.json

@@ -1,11 +1,12 @@
 {
   "name": "news-server",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
-      "version": "1.1.1",
+      "name": "news-server",
+      "version": "1.3.0",
       "license": "ISC",
       "dependencies": {
         "cors": "^2.8.5",
@@ -69,68 +70,18 @@
       }
     },
     "node_modules/ansi-align": {
-      "version": "3.0.0",
+      "version": "3.0.1",
-      "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.0.tgz",
+      "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz",
-      "integrity": "sha512-ZpClVKqXN3RGBmKibdfWzqCY4lnjEuoNzU5T0oEFpfd/z5qJHVarukridD4juLO2FXMiwUQxr9WqQtaYa8XRYw==",
+      "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==",
       "dev": true,
       "dependencies": {
-        "string-width": "^3.0.0"
+        "string-width": "^4.1.0"
-      }
-    },
-    "node_modules/ansi-align/node_modules/ansi-regex": {
-      "version": "4.1.0",
-      "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz",
-      "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==",
-      "dev": true,
-      "engines": {
-        "node": ">=6"
-      }
-    },
-    "node_modules/ansi-align/node_modules/emoji-regex": {
-      "version": "7.0.3",
-      "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz",
-      "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==",
-      "dev": true
-    },
-    "node_modules/ansi-align/node_modules/is-fullwidth-code-point": {
-      "version": "2.0.0",
-      "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz",
-      "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=",
-      "dev": true,
-      "engines": {
-        "node": ">=4"
-      }
-    },
-    "node_modules/ansi-align/node_modules/string-width": {
-      "version": "3.1.0",
-      "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz",
-      "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==",
-      "dev": true,
-      "dependencies": {
-        "emoji-regex": "^7.0.1",
-        "is-fullwidth-code-point": "^2.0.0",
-        "strip-ansi": "^5.1.0"
-      },
-      "engines": {
-        "node": ">=6"
-      }
-    },
-    "node_modules/ansi-align/node_modules/strip-ansi": {
-      "version": "5.2.0",
-      "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz",
-      "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==",
-      "dev": true,
-      "dependencies": {
-        "ansi-regex": "^4.1.0"
-      },
-      "engines": {
-        "node": ">=6"
       }
     },
     "node_modules/ansi-regex": {
-      "version": "5.0.0",
+      "version": "5.0.1",
-      "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz",
+      "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
-      "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==",
+      "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
       "dev": true,
       "engines": {
         "node": ">=8"
@@ -2037,9 +1988,9 @@
       }
     },
     "node_modules/validator": {
-      "version": "13.6.0",
+      "version": "13.7.0",
-      "resolved": "https://registry.npmjs.org/validator/-/validator-13.6.0.tgz",
+      "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz",
-      "integrity": "sha512-gVgKbdbHgtxpRyR8K0O6oFZPhhB5tT1jeEHZR0Znr9Svg03U0+r9DXWMrnRAB+HtCStDQKlaIZm42tVsVjqtjg==",
+      "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==",
       "engines": {
         "node": ">= 0.10"
       }
@@ -2147,58 +2098,18 @@
       }
     },
     "ansi-align": {
-      "version": "3.0.0",
+      "version": "3.0.1",
-      "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.0.tgz",
+      "resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz",
-      "integrity": "sha512-ZpClVKqXN3RGBmKibdfWzqCY4lnjEuoNzU5T0oEFpfd/z5qJHVarukridD4juLO2FXMiwUQxr9WqQtaYa8XRYw==",
+      "integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==",
       "dev": true,
       "requires": {
-        "string-width": "^3.0.0"
+        "string-width": "^4.1.0"
-      },
-      "dependencies": {
-        "ansi-regex": {
-          "version": "4.1.0",
-          "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz",
-          "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==",
-          "dev": true
-        },
-        "emoji-regex": {
-          "version": "7.0.3",
-          "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz",
-          "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==",
-          "dev": true
-        },
-        "is-fullwidth-code-point": {
-          "version": "2.0.0",
-          "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz",
-          "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=",
-          "dev": true
-        },
-        "string-width": {
-          "version": "3.1.0",
-          "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz",
-          "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==",
-          "dev": true,
-          "requires": {
-            "emoji-regex": "^7.0.1",
-            "is-fullwidth-code-point": "^2.0.0",
-            "strip-ansi": "^5.1.0"
-          }
-        },
-        "strip-ansi": {
-          "version": "5.2.0",
-          "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz",
-          "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==",
-          "dev": true,
-          "requires": {
-            "ansi-regex": "^4.1.0"
-          }
-        }
       }
     },
     "ansi-regex": {
-      "version": "5.0.0",
+      "version": "5.0.1",
-      "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz",
+      "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
-      "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==",
+      "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
       "dev": true
     },
     "ansi-styles": {
@@ -3672,9 +3583,9 @@
       "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="
     },
     "validator": {
-      "version": "13.6.0",
+      "version": "13.7.0",
-      "resolved": "https://registry.npmjs.org/validator/-/validator-13.6.0.tgz",
+      "resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz",
-      "integrity": "sha512-gVgKbdbHgtxpRyR8K0O6oFZPhhB5tT1jeEHZR0Znr9Svg03U0+r9DXWMrnRAB+HtCStDQKlaIZm42tVsVjqtjg=="
+      "integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw=="
     },
     "vary": {
       "version": "1.1.2",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "news-server",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "An API centric news server. Uses Sequelize and mariaDB by default.",
   "main": "server/server.js",
   "scripts": {

server/database/models/revisions.js

@@ -17,12 +17,15 @@ const revisions = sequelize.define('revisions', {
 	body: {
 		type: Sequelize.TEXT,
 		defaultValue: ''
+	},
+
+	originalIndex: {
+		type: Sequelize.INTEGER(11),
+		default: null
 	}
 });
 
 //relationships
-articles.hasOne(revisions, { as: 'original' });
-
 sequelize.sync();
 
 module.exports = revisions;

server/news/edit.js

@@ -25,9 +25,9 @@ const route = async (req, res) => {
 
 	//update the data
 	await articles.update({
-		title: req.body.title,
+		title: req.body.title || record.title,
-		author: req.body.author,
+		author: req.body.author || record.author,
-		body: req.body.body,
+		body: req.body.body || record.body,
 		edits: record.edits + 1
 	}, {
 		where: {

server/news/publish.js

@@ -1,6 +1,19 @@
 const { articles } = require('../database/models');
 
 const route = async (req, res) => {
+	//check for missing data
+	if (!req.body.title) {
+		return res.status(401).end("Missing title");
+	}
+
+	if (!req.body.author) {
+		return res.status(401).end("Missing author");
+	}
+
+	if (!req.body.body) {
+		return res.status(401).end("Missing body");
+	}
+
 	//upsert the data
 	const [instance, created] = await articles.upsert({
 		title: req.body.title,

tools/migrations/version-1.3.0.sql

@@ -0,0 +1,6 @@
+use news;
+ALTER TABLE revisions CHANGE COLUMN id `index` INTEGER(11) UNIQUE NOT NULL AUTO_INCREMENT;
+
+ALTER TABLE revisions DROP FOREIGN KEY revisions_ibfk_1;
+
+ALTER TABLE revisions CHANGE COLUMN originalIndex originalIndex INTEGER(11);