just-another-http-api 1.2.8 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/.eslintrc +148 -0
  2. package/api.js +6 -3
  3. package/package.json +10 -10
  4. package/src/cache.js +18 -2
  5. package/utils/WebsocketGroup.js +5 -25
  6. package/eslint.config.js +0 -51
package/.eslintrc ADDED
@@ -0,0 +1,148 @@
1
+ {
2
+ "parserOptions": {
3
+ "ecmaVersion": 12,
4
+ "sourceType": "module",
5
+ "ecmaFeatures": {
6
+ "jsx": true
7
+ }
8
+ },
9
+ "env": {
10
+ "commonjs": true,
11
+ "node": true
12
+ },
13
+ "globals": {
14
+ "__lib": "readonly",
15
+ "__routes": "readonly",
16
+ "__base": "readonly",
17
+ "__utils": "readonly"
18
+ },
19
+ "rules": {
20
+ "max-len": [
21
+ "off",
22
+ 120
23
+ ],
24
+ "semi": [
25
+ "error",
26
+ "always"
27
+ ],
28
+ "no-underscore-dangle": 0,
29
+ "class-methods-use-this": 0,
30
+ "no-param-reassign": 0,
31
+ "no-restricted-syntax": 1,
32
+ "no-continue": 1,
33
+ "consistent-return": 1,
34
+ "guard-for-in": 1,
35
+ "import/no-commonjs": 0,
36
+ "import/no-dynamic-require": 0,
37
+ "new-cap": 1,
38
+ "no-nested-ternary": 0,
39
+ "prefer-const": "error",
40
+ "newline-before-return": "error",
41
+ "quotes": [
42
+ "error",
43
+ "single"
44
+ ],
45
+ "no-multiple-empty-lines": [
46
+ "error",
47
+ {
48
+ "max": 1
49
+ }
50
+ ],
51
+ "space-before-function-paren": [
52
+ "error",
53
+ "always"
54
+ ],
55
+ "func-call-spacing": [
56
+ "error",
57
+ "always"
58
+ ],
59
+ "block-spacing": [
60
+ "error",
61
+ "always"
62
+ ],
63
+ "space-in-parens": [
64
+ "error",
65
+ "always"
66
+ ],
67
+ "object-curly-spacing": [
68
+ "error",
69
+ "always"
70
+ ],
71
+ "no-spaced-func": 0,
72
+ "space-unary-ops": [
73
+ "error",
74
+ {
75
+ "words": true,
76
+ "nonwords": false,
77
+ "overrides": {
78
+ "new": false,
79
+ "++": false
80
+ }
81
+ }
82
+ ],
83
+ "arrow-spacing": [
84
+ "error",
85
+ {
86
+ "before": true,
87
+ "after": true
88
+ }
89
+ ],
90
+ "indent": [
91
+ "error",
92
+ 4,
93
+ {
94
+ "SwitchCase": 1
95
+ }
96
+ ],
97
+ "key-spacing": [
98
+ "error",
99
+ {
100
+ "beforeColon": false,
101
+ "afterColon": true
102
+ }
103
+ ],
104
+ "computed-property-spacing": [
105
+ "error",
106
+ "always"
107
+ ],
108
+ "array-bracket-spacing": [
109
+ "error",
110
+ "always"
111
+ ],
112
+ "comma-spacing": [
113
+ "error",
114
+ {
115
+ "before": false,
116
+ "after": true
117
+ }
118
+ ],
119
+ "brace-style": [
120
+ "error",
121
+ "stroustrup"
122
+ ],
123
+ "space-infix-ops": [
124
+ "error",
125
+ {
126
+ "int32Hint": true
127
+ }
128
+ ],
129
+ "keyword-spacing": [
130
+ "error",
131
+ {
132
+ "overrides": {
133
+ "if": {
134
+ "after": true
135
+ },
136
+ "for": {
137
+ "after": true
138
+ },
139
+ "while": {
140
+ "after": true
141
+ }
142
+ }
143
+ }
144
+ ],
145
+ "no-octal-escape": 0,
146
+ "no-octal": 0
147
+ }
148
+ }
package/api.js CHANGED
@@ -36,6 +36,9 @@ async function createServer ( config ) {
36
36
  if ( config.websocket?.enabled ){
37
37
  app.register ( require ( '@fastify/websocket' ), config.websocket?.options );
38
38
  }
39
+ if (config.cookies?.enabled) {
40
+ app.register ( require ( '@fastify/cookie' ), config.cookies );
41
+ }
39
42
  await uploads.initialiseUploads ( app, config );
40
43
  await caching.initialiseCaching ( app, config );
41
44
  await auth.initialiseAuth ( app, config );
@@ -118,11 +121,11 @@ function fastifyHandlerWrapper ( handler, config, globalConfig, method ) {
118
121
  try {
119
122
  let response;
120
123
  if ( globalConfig?.cache?.enabled ){
121
- const request = { method: req.method, query: JSON.parse ( JSON.stringify ( req.query ) ), routeOptions: req.routeOptions };
124
+ const request = { method: req.method, query: JSON.parse ( JSON.stringify ( req.query ) ), routeOptions: req.routeOptions, params: JSON.parse ( JSON.stringify ( req.params ) ) };
122
125
  response = await caching.checkRequestCache ( app, request, reply, config, globalConfig );
123
-
126
+
124
127
  if ( !response ){
125
- response = await handler ( req );
128
+ response = await handler ( req, { invalidateRequest: ( _req ) => caching.invalidateRequestCache( app, _req, globalConfig ) } );
126
129
  await caching.setRequestCache ( app, request, response, config, globalConfig );
127
130
  }
128
131
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "just-another-http-api",
3
- "version": "1.2.8",
3
+ "version": "1.3.0",
4
4
  "description": "A framework built on top of fastify aimed at removing the need for any network or server configuration. ",
5
5
  "homepage": "https://github.com/OllieEdge/just-another-http-api#readme",
6
6
  "repository": {
@@ -25,23 +25,23 @@
25
25
  "author": "Oliver Edgington <oliver@edgington.com> (https://github.com/OllieEdge)",
26
26
  "license": "MIT",
27
27
  "dependencies": {
28
- "@aws-sdk/lib-storage": "^3.569.0",
28
+ "@aws-sdk/lib-storage": "^3.454.0",
29
29
  "@fastify/caching": "^8.3.0",
30
- "@fastify/cors": "^9.0.1",
30
+ "@fastify/cookie": "^9.4.0",
31
+ "@fastify/cors": "^8.4.1",
31
32
  "@fastify/jwt": "^7.2.3",
32
- "@fastify/redis": "^6.2.0",
33
- "@fastify/websocket": "^10.0.1",
33
+ "@fastify/redis": "^6.1.1",
34
+ "@fastify/websocket": "^8.2.0",
34
35
  "abstract-cache": "^1.0.1",
35
36
  "abstract-cache-redis": "^2.0.0",
36
- "eip-cloud-services": "^1.1.9",
37
- "fastify": "^4.27.0",
37
+ "fastify": "^4.24.3",
38
38
  "fastify-multer": "^2.0.3",
39
39
  "recursive-readdir": "^2.2.3"
40
40
  },
41
41
  "devDependencies": {
42
42
  "chai": "^4.3.10",
43
43
  "chai-as-promised": "^7.1.1",
44
- "eslint": "^9.2.0",
45
- "mocha": "^10.4.0"
44
+ "eip-cloud-services": "^1.1.0",
45
+ "mocha": "^10.2.0"
46
46
  }
47
- }
47
+ }
package/src/cache.js CHANGED
@@ -1,4 +1,12 @@
1
- const getCacheKey = ( config, req ) => `${config?.cache?.redisPrefix || ''}:${req.method.toLowerCase ()}:${req.routeOptions.url}:${JSON.stringify ( req.query )}`;
1
+ const getCacheKey = (config, req) => {
2
+ let url = req.routeOptions.url;
3
+
4
+ for (const [ param, value ] of Object.entries( req.params || {} )) {
5
+ url = url.replace(`:${param}`, value);
6
+ }
7
+
8
+ return `${config?.cache?.redisPrefix || ''}:${req.method.toLowerCase()}:${url}:${JSON.stringify( req.query )}`;
9
+ };
2
10
 
3
11
  exports.initialiseCaching = async ( app, config ) => {
4
12
 
@@ -66,4 +74,12 @@ exports.setRequestCache = async ( app, req, response, handleConfig, globalConfig
66
74
  }
67
75
 
68
76
  }
69
- };
77
+ };
78
+
79
+ exports.invalidateRequestCache = async ( app, req, globalConfig ) => {
80
+ if ( globalConfig?.cache?.enabled ) {
81
+ const cacheKey = getCacheKey ( globalConfig, req );
82
+
83
+ await app.redis.del ( cacheKey );
84
+ }
85
+ };
package/utils/WebsocketGroup.js CHANGED
@@ -11,7 +11,6 @@ class WebsocketGroup {
11
11
  this.connections = new Map ();
12
12
  this.messageReceivedHandler = messageReceivedHandler || ( async () => {} );
13
13
  this.connectionClosedHandler = connectionClosedHandler;
14
- this.pingConnections = setInterval ( this.#pingConnections.bind ( this ), 30000 );
15
14
  }
16
15
 
17
16
  async initialize () {
@@ -32,30 +31,17 @@ class WebsocketGroup {
32
31
 
33
32
  #broadcastMessageToClients ( message ) {
34
33
  this.connections.forEach ( conn => {
35
- conn.send ( typeof message === 'string' ? message : JSON.stringify ( message ) );
34
+ conn.socket.send ( typeof message === 'string' ? message : JSON.stringify ( message ) );
36
35
  } );
37
36
  }
38
37
 
39
38
  #handleIndividualMessage ( individualMessage ) {
40
39
  const { connectionId, message } = JSON.parse ( individualMessage );
41
40
  if(this.connections.has(connectionId)) {
42
- this.connections.get(connectionId).send(message);
41
+ this.connections.get(connectionId).socket.send(message);
43
42
  }
44
43
  }
45
44
 
46
- #pingConnections () {
47
- this.connections.forEach ( ( connection, connectionId ) => {
48
- if(!connection.isAlive) {
49
- this.connections.delete ( connectionId );
50
- this.#clean(connectionId);
51
- }
52
- else{
53
- connection.isAlive = false;
54
- connection.ping ();
55
- }
56
- } );
57
- }
58
-
59
45
  getConnections () {
60
46
  return this.connections;
61
47
  }
@@ -69,10 +55,9 @@ class WebsocketGroup {
69
55
  }
70
56
 
71
57
  addNewConnection ( connection, connectionId = crypto.randomUUID () ) {
72
- connection.isAlive = true;
73
58
  this.connections.set ( connectionId, connection );
74
59
 
75
- connection.on ( 'message', async message => {
60
+ connection.socket.on ( 'message', async message => {
76
61
  const userMessage = {
77
62
  groupName: this.groupName,
78
63
  connectionId,
@@ -81,16 +66,12 @@ class WebsocketGroup {
81
66
  await redis.publish ( `${this.groupName}_messageReceived`, JSON.stringify ( userMessage ) );
82
67
  } );
83
68
 
84
- connection.on ( 'close', () => {
69
+ connection.socket.on ( 'close', () => {
85
70
  this.connections.delete ( connectionId );
86
71
  this.#clean(connectionId);
87
72
  } );
88
-
89
- connection.on ( 'pong', () => {
90
- connection.isAlive = true;
91
- } );
92
73
 
93
- connection.on ( 'error', error => {
74
+ connection.socket.on ( 'error', error => {
94
75
  console.error ( 'WebSocket error:', error );
95
76
  this.connections.delete ( connectionId );
96
77
  this.#clean(connectionId);
@@ -111,7 +92,6 @@ class WebsocketGroup {
111
92
  }
112
93
 
113
94
  if ( this.connections.size === 0 ) {
114
- clearInterval ( this.pingConnections );
115
95
  this.connections.clear ();
116
96
  await redis.unsubscribe ( `${this.groupName}_individualMessage` );
117
97
  await redis.unsubscribe ( `${this.groupName}_broadcast` );
package/eslint.config.js DELETED
@@ -1,51 +0,0 @@
1
- module.exports = [ {
2
- languageOptions: {
3
- ecmaVersion: 2021,
4
- sourceType: 'module',
5
- parserOptions: {
6
- ecmaFeatures: {
7
- jsx: true
8
- }
9
- }
10
- },
11
- rules: {
12
- 'max-len': 'off',
13
- 'semi': [ 'error', 'always' ],
14
- 'no-underscore-dangle': 'off',
15
- 'class-methods-use-this': 'off',
16
- 'no-param-reassign': 'off',
17
- 'no-restricted-syntax': 'warn',
18
- 'no-continue': 'warn',
19
- 'consistent-return': 'warn',
20
- 'guard-for-in': 'warn',
21
- 'import/no-commonjs': 'off',
22
- 'import/no-dynamic-require': 'off',
23
- 'new-cap': 'warn',
24
- 'no-nested-ternary': 'off',
25
- 'prefer-const': 'error',
26
- 'newline-before-return': [ 'error', 'always' ],
27
- 'quotes': [ 'error', 'single' ],
28
- 'no-multiple-empty-lines': [ 'error', { max: 1 } ],
29
- 'space-before-function-paren': [ 'error', 'always' ],
30
- 'func-call-spacing': [ 'error', 'always' ],
31
- 'block-spacing': [ 'error', 'always' ],
32
- 'space-in-parens': [ 'error', 'always' ],
33
- 'object-curly-spacing': [ 'error', 'always' ],
34
- 'no-spaced-func': 'off',
35
- 'space-unary-ops': [ 'error', { 'words': true, 'nonwords': false, 'overrides': { 'new': false, '++': false } } ],
36
- 'arrow-spacing': [ 'error', { 'before': true, 'after': true } ],
37
- 'indent': [ 'error', 4, { 'SwitchCase': 1 } ],
38
- 'key-spacing': [ 'error', { 'beforeColon': false, 'afterColon': true } ],
39
- 'computed-property-spacing': [ 'error', 'always' ],
40
- 'array-bracket-spacing': [ 'error', 'never' ],
41
- 'comma-spacing': [ 'error', { 'before': false, 'after': true } ],
42
- 'brace-style': [ 'error', 'stroustrup' ],
43
- 'space-infix-ops': 'error',
44
- 'keyword-spacing': [ 'error', { overrides: {
45
- if: { after: true },
46
- for: { after: true },
47
- while: { after: true }
48
- } } ],
49
- 'array-bracket-spacing': [ 'error', 'always' ],
50
- },
51
- } ];