Service Integration Diagram for Social Web Demo

[p5150j]

Task: Service Integration Diagram for Social Web Demo

Objective: Create a comprehensive diagram illustrating the integration between existing services and the social web demo components. This diagram should clearly delineate which services interact with specific parts of the social web demo, including both the backend and frontend components.

Resources:

• Gateway Template App Backend: GitHub - AmplicaLabs/dsnp-gateway-prototype
• Gateway Template App Frontend: GitHub - AmplicaLabs/social-web-demo
• Existing Services:
  • Graph Service: GitHub - AmplicaLabs/graph-service
  • Content Watcher Service: GitHub - AmplicaLabs/content-watcher-service
  • Content Publishing Service: GitHub - AmplicaLabs/content-publishing-service
  • Reconnection Service: GitHub - AmplicaLabs/reconnection-service

Steps:

1. Review Prototypes: Examine the current implementations of the gateway template app backend and frontend. Identify functionalities that are candidates for service-based replacements.
2. Identify Integrations: For each part of the social web demo (e.g., content posting, feed display, auth etc), determine which existing service (if any) should replace or enhance its functionality. Pay particular attention to:
   • How the Content Watcher and Content Publishing Services can replace or augment the current method of posting content and displaying feeds.
   • Potential interactions between the Graph Service, Reconnection Service, and other components of the demo.
3. Diagram Creation: Using the information gathered, create a detailed diagram that:
   • Shows which services interact with specific parts of the social web demo.
   • Highlights the flow of data between services and components.
   • Includes placeholders for services that need to be developed or don't yet exist, indicating their anticipated connections and functionalities.
   • Includes placeholders for features currently missing from the gateway template app that would be necessary or desirable for a complete 'social web' app
4. Gap Analysis: Identify functionalities in the social web demo that are not yet covered by existing services. Suggest new services (e.g., a Session Service) that need to be developed to fill these gaps, including a brief description of their intended functionality.

Acceptance Criteria:

• A detailed integration diagram is delivered, clearly illustrating how each part of the social web demo interacts with the existing services and indicating the flow of data.
• The diagram includes indications of where new services are needed, with suggested names and functionalities.
• All components of both the backend and frontend are accounted for in the diagram.
• A written summary accompanies the diagram, explaining the key integration points and any recommendations for new services or user interfaces to be developed.

[enddynayn]

How it works now:

What is missing:

Summary:
We are missing wiring up content publisher, graph service, and content watcher. This wiring may require adding the following endpoints:

• v1/assets endpoint - upload assets
• v1/webhooks/content - receive annoucements
• v1/webhooks/graph - receive graph changes
• /v1/content/{type}/{contentHash - Edit content
• /v1/content/{dsnpId}/{contentHash} - Get details of a specific post

Additionally, we need to also create a simple feed service (not microservice) to generate a feed for a user. We are also missing an account service to facilitate interaction with the chain.

List of tickets for some of these items in more detail:

• Uploading assets - Gateway-Backend: Connect Content Publishing Service For Uploading Assets social-app-template#2
• Integrating content publisher - Gateway-Backend: Integration of Content Publishing Service for Broadcasting Messages dsnp-gateway-prototype#7
• Updating Social APP - Client: Update posting to new v2 endpoint social-web-demo#2
• Add docker - Dockerize DSNP-gateway for Improved Deployment dsnp-gateway-prototype#8
• Add docker compose Integrate Content-Publisher Service Using Docker Compose dsnp-gateway-prototype#9
• Testing and Listing - Setup GitHub Actions for Testing and Linting dsnp-gateway-prototype#10
• Implement endpoint to retrieve post - Implement Endpoint to Retrieve Post Details dsnp-gateway-prototype#11
• Edit post endpoint - Implement Endpoint to Edit Post social-app-template#129
• Receive Content from Content Watcher - Implement Endpoint to Receive Content form Content Watcher dsnp-gateway-prototype#12
• Receive content from Graph Watcher - Implement Endpoint to Receive Graph Services dsnp-gateway-prototype#13

Additional diagrams:
https://whimsical.com/gateway-8dfo4hLYPFUgEeafK6zpwx

[p5150j]

@enddynayn

Thanks for making the updates!!

Looking at the AC:

• ✅ A detailed integration diagram is delivered, clearly illustrating how each part of the social web demo interacts with the existing services and indicating the flow of data.

• ✅ The diagram includes indications of where new services are needed, with suggested names and functionalities.
  All components of both the backend and frontend are accounted for in the diagram.

• 🚫 A written summary accompanies the diagram, explaining the key integration points and any recommendations for new services or user interfaces to be developed.

Notes:
I see the new services or user interfaces to be developed in the "What is missing diagram" (session service, messaging service, feed handler etc ) but what I dont see is a written summary for anything that is "missing" to accompany them. For example: We need a messaging service whose key responsibility is x y and z, or we need a session service whose key responsibility is x y and z and it talks to q, r, s service

[enddynayn]

It's easy to miss here you go.

Summary:
We are missing wiring up content publisher, graph service, and content watcher. This wiring may require adding the following endpoints:

v1/assets endpoint - upload assets
v1/webhooks/content - receive annoucements
v1/webhooks/graph - receive graph changes
/v1/content/{type}/{contentHash - Edit content
/v1/content/{dsnpId}/{contentHash} - Get details of a specific post
Additionally, we need to also create a simple feed service (not microservice) to generate a feed for a user. We are also missing an account service to facilitate interaction with the chain.

[enddynayn]

I'll elaborate a little more.

We are missing:
Account Service - Currently under development to facilitate any chain interaction with creating an account.
Session Service/Auth - A service that follows best standards and integrates with SignInWithFrequency. This allows
developers not to worry about creating sessions and authentication.
Messaging Service - A service for allowing users to send direct messages.
Feed Handler - Not a service but logic that needs to be implemented once we integrate with content-watcher and content-publisher.

[p5150j]

Thanks @enddynayn