genjudev / strapio Goto Github PK

Socket.IO Implementation for Strapi

JavaScript 97.67% Shell 2.33%

strapio's Introduction

StrapIO

module for working with socket.io with predefined rules. StrapIO will look at Role permission on each action. StrapIO is looking for all roles which have access to the given contenttype and action type.

UPDATE v2: You need to subscribe first before you receive any data. socket.emit('subscribe', 'article') article is the content-type.

using Strapi v3?

you need to install strapio v2. Version 3 will not work with strapi below 4.

Installation

npm i strapio

src/index.js

bootstrap({strapi}) {
        process.nextTick(() => {
            strapi.StrapIO = (require("strapio"))(strapi);
        });
 },

Configuration socket.io

bootstrap({strapi}) {
        process.nextTick(() => {
            strapi.StrapIO = (require("strapio"))(strapi, {
              path: "/other/path/",
              cors: { origin: "*", methods: ["GET", "POST"] },
            });
        });
 },

Usage

server

api/<content-type>/controllers/<content-type>.js

module.exports = {
  async create(ctx) {
    let entity;
    if (ctx.is("multipart")) {
      const { data, files } = parseMultipartData(ctx);
      entity = await strapi.services.CONTENTTYPE.create(data, { files });
    } else {
      entity = await strapi.services.CONTENTTYPE.create(ctx.request.body);
    }
    strapi.StrapIO.emit(this, "create", entity);

    // or send custom event
    strapi.StrapIO.emitRaw("myroom", "myevent", entity);

    return sanitizeEntity(entity, { model: strapi.models.CONTENTTYPE });
  },

  async update(ctx) {
    const { id } = ctx.params;

    let entity;
    if (ctx.is("multipart")) {
      const { data, files } = parseMultipartData(ctx);
      entity = await strapi.services.CONTENTTYPE.update({ id }, data, {
        files,
      });
    } else {
      entity = await strapi.services.CONTENTTYPE.update(
        { id },
        ctx.request.body
      );
    }

    strapi.StrapIO.emit(this, "update", entity);

    return sanitizeEntity(entity, { model: strapi.models.CONTENTTYPE });
  },
};

Client

const io = require("socket.io-client");

// Handshake required, token will be verified against strapi
const socket = io.connect(API_URL, {
  query: { token },
});

socket.emit("subscribe", "article"); // article is the room which the client joins

socket.on("find", (data) => {
  console.log("article:", data);
  //do something
});
socket.on("update", (data) => {
  // do something
});

Client, Web

<script src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/4.2.0/socket.io.js"></script>
<script>
  // Handshake required, token will be verified against strapi
  (function () {
    const socket = io("http://localhost:1337/", {
      path: "/sockettest/",
      query: {
        token,
      },
    });

    socket.emit("subscribe", "article"); // article is the room which the client joins
    socket.emit("subscribe", "myroom"); // custom room

    socket.on("find", (data) => {
      //do something
    });
    socket.on("update", (data) => {
      // do something
    });

    socket.on("myevent", (data) => {});
  })();
</script>

Full example project

https://github.com/larsonnn/strapio-example-project

debugging

DEBUG=strapio npm run develop
DEBUG=* npm run develop

Test

Currently tested with strapi v4

Plugin for strapi

You can install strapio with a plugin npm i strapi-plugin-socket-io.

Contribute

just do it over github or chat with me @Discord

strapio's People

Contributors

Stargazers

Watchers

Forkers

l3th2nh udje adamspouele penguin424 subtirelumihail hongsw reggionick tention heyjaypray anwarpro nisthar dennebgmz david-vaclavek

strapio's Issues

Unable to get it working with version 4

Hi,

i have followed the readme to get strapio working with v4 but, i got 404 notFound..

i have tried to harcoded the JWT token, but still unable to get the socket.io working.

Bug in Token Verification?

Multiple emits Error

When having multiple Roles with permission for a Content-Type payloads are emitted multiple times.

    for (var i in roles) { //<--- problem
      const roleDetail = await this._upServices().userspermissions.getRole(
        roles[i].id,
        plugins
      );
      if (
        roleDetail.permissions.application.controllers[
          vm.identity.toLowerCase()
        ][action].enabled
      ) {
		console.log(i)
        if(entity._id || entity.id) {
          this.io.sockets
          .in(`${vm.identity.toLowerCase()}_${entity._id || entity.id}`)
          .emit(action, this.sendDataBuilder(vm.identity, entity))
        }
        this.io.sockets
          .in(vm.identity.toLowerCase())
          .emit(action, this.sendDataBuilder(vm.identity, entity));
      }
    }

Missing Comma

A comma between each async statement is required in the {controller}.js file.

Plan to include the Admin UI?

Is there any plan to include the Admin UI of socket.io?

https://socket.io/docs/v4/admin-ui/

Listning to incoming events

A client needs to send socket events to the server and the server has to listen to the incoming events. Socket.io implements the following methods: .on, .once, off, removeAllListeners. In Strapi v3 I was able to use them as follows:

const io = require('socket.io')(strapi.server, {
  // optional config
})

io.on('connection', function(socket) {
  socket.on('someCommand', () => {
    // ...do something here
  })
})

Alas, it is no longer possible with v4. And the StrapIO plugin currently doesn't support this much needed functionality.

I tried the solution you suggested in your Discord channel:

process.nextTick(() => {
  const _strapio = (require("strapio"))(strapi, {
    cors: { origin: "*", methods: ["GET", "POST"] },
  });

  _strapio.io.on('connection', () => {
    console.log('user connected')
  })

  strapi.io = _strapio.io
})

But getting this error: TypeError: Cannot read property 'on' of undefined. There's no io property on the object returned by the plugin.

Breaking changes from 4.0 to 4.0.6

I was not able to get this to work on Strapi >4.0.6 with the adjustments that they made to how plugin extensions work (possibly the case)

the user-permissions plugin seems to have changed as well

To note: I'm currently using 4.1

the Migration notes:
https://docs.strapi.io/developer-docs/latest/update-migration-guides/migration-guides/v4/migration-guide-4.0.x-to4.0.6.html

Usage with PM2

Is there a way to use this module when Strapi is launched with PM2 on multiple instances?

Bug in Token verification

I maybe came across some issues with the checking of a token:

Is it intended, that a connection can be established even if no token is provided (no query object at all)?
To go even further: If a user connects without a token, he will receive ALL events without permission checking...

If a user connects to the socket with an invalid token, it causes an exception in strapi, but the user did not get any feedback over the socket, that maybe the token is invalid.

Could you verify that there may is a bug in this package?

Listen to connect events on server

when a client/user connects with the server, there must be an event to it like socket.io has on.connect event, on disconnect event.

Update Readme

Add documentation for the config block that it is exactly the same as refernced in the socket.io official documentation
option, non optional configs