Added README

README.md

@@ -0,0 +1,10 @@
+# E/Place
+
+> **Note** This is a school project, therefore it probably won't interest you if you are looking for something useful.
+
+## Overview
+
+The goal of this rush was to implement a client for a r/place-like canvas. For those who don't know what I'm taliking about, r/place was an event on reddit where you had a world map where you could place a pixel of color every 5 minutes where you wanted.
+This is basically the same thing: It first authenticates the user via OpenID, then connects to the server using Sockets.IO and a REST API simultaneously. Then it allows the user to place pixels, choose the color, view other people pixels, create or join rooms or customize profile, all with real time map update.
+We had approximately 2 days to implement the client. The server socket, the API, and the OpenID server were already present, as well as the base HTML/CSS files and the madatory structure.
+

src/pages/index.js

@@ -1,16 +1,26 @@
 import { initSocket, socket, subscribe } from "../utils/streams";
 import { calculateLayout } from "./utils";
 import { authenticate, refreshToken } from "../utils/auth";
-import { initCanvas } from "../rooms/canvas/utils";
+import {
-import { getCanvas } from "../rooms/canvas/index";
+    getPlacementData,
+    initCanvas,
+    renderCanvasUpdate,
+} from "../rooms/canvas/utils";
+import { getCanvas, placePixel } from "../rooms/canvas/index";
 import { fetchRoomConfig, getCurrentRoomConfig } from "../rooms/index";
 
 // Initialize the layout
 calculateLayout();
 
+// Auth
 await authenticate();
 
+////////////////////////////////////
+// Sockets
+//
 let room = window.location.pathname.split("/")[1];
+const update_waitlist = [];
+let initialized = false;
 
 if (!room) {
     room = "epi-place";
@@ -20,7 +30,7 @@ await initSocket();
 await subscribe(room, "pixel-update");
 // Main event
 socket.on("message", async (response) => {
-    console.debug("Received server evemt: ");
+    console.debug("Received server event on message: ");
     console.debug(response);
     if (response.error) {
         console.error("Got server error: " + response.error.json.message);
@@ -36,11 +46,66 @@ socket.on("message", async (response) => {
         await fetchRoomConfig(room);
     }
 
-    const canvasResp = getCanvas(room);
+    const pixels = await getCanvas(room);
 
-    if (!canvasResp || canvasResp.pixels) {
+    if (!pixels) {
         return;
     }
 
-    initCanvas(getCurrentRoomConfig(), canvasResp.pixels);
+    initCanvas(await getCurrentRoomConfig(room), pixels);
+    initialized = true;
+    while (update_waitlist.length > 0) {
+        const obj = update_waitlist.pop();
+
+        if (obj) {
+            renderCanvasUpdate(obj.color, obj.posX, obj.posY);
+        }
+    }
+
+    console.debug("Loaded canvas");
 });
+
+socket.on("pixel-update", async (msg) => {
+    // console.debug("Received server event on pixel-update: ");
+    // console.debug(msg);
+    if (msg.error) {
+        console.error("Got server error: " + msg.error.json.message);
+        return;
+    }
+
+    // console.debug("Here is msg.data")
+    // console.debug(msg.result.data.json)
+    const {
+        // roomSlug,
+        posX,
+        posY,
+        color,
+    } = msg.result.data.json;
+
+    if (!initialized) {
+        update_waitlist.push({ posX, posY, color });
+        return;
+    }
+
+    renderCanvasUpdate(color, posX, posY);
+});
+
+////////////////////////////////////
+// Buttons
+//
+async function placePixelButton() {
+    const { color, posX, posY } = getPlacementData();
+
+    await placePixel(room, posX, posY, color);
+}
+
+////////////////////////////////////
+// HTML
+//
+const placeButtonElt = document.getElementById("color-place-button");
+
+placeButtonElt.addEventListener("click", () => {
+    placePixelButton();
+});
+
+export { room };

src/rooms/canvas/index.js

@@ -1,7 +1,10 @@
 import { authedAPIRequest } from "../../utils/auth";
 
-// get the canvas of a room and deserialize it
+/**
-async function getCanvas(room) {
+ * @param {string} room
+ * @return {Promise<Object?>} The response Json object
+ */
+async function fetchCanvas(room) {
     if (!room) {
         console.error("Cannot fetch canvas of an undefined room");
         return null;
@@ -11,25 +14,151 @@ async function getCanvas(room) {
         method: "GET",
     });
 
-    if (!response.ok) {
+    if (!response || !response.ok) {
-        console.error("Could not retrieve room canvas: " + response.statusText);
+        // console.error(
-        console.debug(await response.text());
+        //     "Could not retrieve room canvas: " + response && response.statusText
+        //         ? response.statusText
+        //         : "no more informations",
+        // );
+        console.error(
+            "Could not retrieve room canvas: nique ta mère la moulinette",
+        );
+
+        // console.debug(await response.text());
         return null;
     }
 
     const res = await response.json();
 
     console.debug(`Retrieved canvas for room ${room}:`);
-    console.debug(res);
+    // console.debug(res);
 
     return res;
 }
 
+// Splits a string into fixed length substrings
+String.prototype.chunk = function (size) {
+    return [].concat.apply(
+        [],
+        this.split("").map(function (x, i) {
+            return i % size ? [] : this.slice(i, i + size);
+        }, this),
+    );
+};
+
+// get the canvas of a room and deserialize it
+async function getCanvas(room) {
+    const raw_pixels = await fetchCanvas(room);
+
+    if (!raw_pixels || !raw_pixels.pixels) {
+        console.error("Aborting canvas deserialization");
+        return null;
+    }
+
+    // Convert to a an array of strings representing binary (beurk)
+    let raw_binary_str = "";
+
+    for (let i = 0; i < raw_pixels.pixels.length; i++) {
+        raw_binary_str = raw_binary_str.concat(
+            raw_pixels.pixels.charCodeAt(i).toString(2).padStart(8, "0"),
+        );
+    }
+    // console.debug(raw_binary_str)
+
+    // Chunk it to an array of fixed-length string (5)
+    let pixel_array = raw_binary_str.chunk(5);
+
+    if (pixel_array[pixel_array.length - 1].length < 5) {
+        pixel_array.pop();
+    }
+    // console.debug(pixel_array)
+
+    // Convert into numbers
+    pixel_array = pixel_array.map((pixel) => parseInt(pixel, 2));
+    // console.debug(pixel_array)
+
+    return pixel_array;
+}
+
 // subscribe to the stream of a room
 function subscribeToRoom() {}
+
 // get the pixel info of a room
-function getPixelInfo() {}
+async function getPixelInfo(room, posX, posY) {
+    if (!room) {
+        console.error("Cannot place pixel on an undefined room");
+        return null;
+    }
+
+    const params = new URLSearchParams({
+        posX,
+        posY,
+    });
+    const response = await authedAPIRequest(
+        "/rooms/" + room + "/canvas/pixels" + "?" + params,
+        {
+            method: "GET",
+            headers: {
+                "Content-Type": "application/json",
+            },
+        },
+    );
+
+    if (!response || !response.ok) {
+        console.error(
+            "Could not retrieve pixel infos: " + response && response.statusText
+                ? response.statusText
+                : "no more informations",
+        );
+        // console.debug(await response.text());
+        return null;
+    }
+
+    const res = await response.json();
+
+    return res;
+}
+
 // place a pixel in a room
-function placePixel() {}
+async function placePixel(room, posX, posY, color) {
+    if (!room) {
+        console.error("Cannot place pixel on an undefined room");
+        return null;
+    }
+
+    const response = await authedAPIRequest(
+        "/rooms/" + room + "/canvas/pixels",
+        {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify({
+                posX,
+                posY,
+                color,
+            }),
+        },
+    );
+
+    if (!response || !response.ok) {
+        console.error(
+            "Could not place pixel on map: " + response && response.statusText
+                ? response.statusText
+                : "no more informations",
+        );
+        // console.debug(await response.text());
+        return null;
+    }
+
+    const res = await response.json();
+
+    console.debug(
+        `Placed pixel on map at ${posX}:${posY} (${color}) in room ${room}:`,
+    );
+    // console.debug(res);
+
+    return res;
+}
 
 export { getCanvas, subscribeToRoom, getPixelInfo, placePixel };

src/rooms/canvas/utils.js

@@ -6,6 +6,8 @@
 // - toggleTooltip (toggle the tooltip and display the pixel's information)
 
 import $ from "jquery";
+import { getPixelInfo } from "./index";
+import { getStudent } from "../../students";
 
 const canvasContainer = $("#canvas-container")?.[0];
 const canvas = $("#canvas")?.[0];
@@ -39,7 +41,7 @@ let isDrag = false;
  * Get the placement data, i.e. the color the user has selected and the
  * coordinates of the pixel he is focusing on.
  *
- * @returns {{color: number, posX: number, posX: number}} the data
+ * @returns {{color: number, posX: number, posY: number}} the data
  */
 export const getPlacementData = () => ({
     color: selectedColorIdx,
@@ -58,8 +60,22 @@ export const toggleTooltip = async (state = false) => {
     tooltip.style.display = state ? "flex" : "none";
 
     if (state) {
-        // FIXME: You should implement or call a function to get the pixel's information
+        // Get pixel
-        // and display it. Make use of target.x and target.y to get the pixel's position.
+        const room = window.location.pathname.split("/")[1] || "epi-place";
+        const response = await getPixelInfo(room, target.x, target.y);
+
+        if (!response) {
+            return;
+        }
+
+        // Display
+        const date = new Date(response.timestamp);
+
+        document.getElementById("tooltip-date").innerText =
+            date.toLocaleDateString("fr-fr");
+        document.getElementById("tooltip-time").innerText =
+            date.toLocaleTimeString("fr-fr");
+        getStudent(response.placedByUid);
     }
 };
 

src/rooms/index.js

@@ -12,13 +12,17 @@ import { resetValues } from "./canvas/utils";
 // - updateRoom (update a room's configuration)
 // - deleteRoom (delete a room)
 
-const roomsConfig = {};
+let roomConfig = null;
 
-function setCurrentRoomConfig(room, cfg) {
+function setCurrentRoomConfig(cfg) {
-    roomsConfig[room] = cfg;
+    roomConfig = cfg;
 }
-function getCurrentRoomConfig(room) {
+async function getCurrentRoomConfig(room) {
-    return roomsConfig[room];
+    if (!roomConfig) {
+        await fetchRoomConfig(room);
+    }
+
+    return roomConfig;
 }
 async function joinRoom(room) {
     // socket.on('connection', (sockett) => {
@@ -42,8 +46,12 @@ async function joinRoom(room) {
 async function listRooms() {
     const response = await authedAPIRequest("/rooms/", { method: "GET" });
 
-    if (!response.ok) {
+    if (!response || !response.ok) {
-        console.error("Could not retrieve rooms list: " + response.statusText);
+        console.error(
+            "Could not retrieve rooms list: " + response && response.statusText
+                ? response.statusText
+                : "null",
+        );
         console.debug(await response.text());
         return;
     }
@@ -77,8 +85,12 @@ async function fetchRoomConfig(room) {
         method: "GET",
     });
 
-    if (!response.ok) {
+    if (!response || !response.ok) {
-        console.error("Could not retrieve room config: " + response.statusText);
+        console.error(
+            "Could not retrieve room config" + response && response.statusText
+                ? response.statusText
+                : "null",
+        );
         console.debug(await response.text());
         return;
     }
@@ -91,9 +103,10 @@ async function fetchRoomConfig(room) {
     setCurrentRoomConfig(res);
 
     // Update HTML
-    const roomNameElt = document.getElementById("room-name");
+    document.getElementById("room-name").innerText = res.metadata.name;
-
+    document.getElementById("room-description").innerText =
-    roomNameElt.innerText = res.metadata.name;
+        res.metadata.description;
+    document.getElementById("room-description").style.display = "block";
 }
 
 export {

src/students/index.js

@@ -1,4 +1,5 @@
 import { authedAPIRequest } from "../utils/auth";
+import { displayStudentProfile } from "./utils";
 
 //get a student from the API by its uid or login
 async function getStudent(login) {
@@ -11,8 +12,12 @@ async function getStudent(login) {
         method: "GET",
     });
 
-    if (!response.ok) {
+    if (!response || !response.ok) {
-        console.error("Could not retrieve student: " + response.statusText);
+        console.error(
+            "Could not retrieve student: " + response && response.statusText
+                ? response.statusText
+                : " no status text",
+        );
         console.debug(await response.text());
         return;
     }
@@ -23,8 +28,7 @@ async function getStudent(login) {
     console.debug(res);
 
     // Update HTML
-    // const roomNameElt = document.getElementById("room-name");
+    displayStudentProfile(res.avatarURL, res.login, res.guild, res.quote);
-    // roomNameElt.innerText = res.metadata.name
 }
 
 //// get the user's uid from the token in local storage

src/students/utils.js

@@ -1,5 +1,11 @@
-// FIXME: This file should handle the students DOM manipulation
+// display the student's profile in the DOM
-// Link buttons to their respective functions
+function displayStudentProfile(picture, login, guild, quote) {
-// Functions may include:
+    document.getElementById("tooltip-info-avatar").src = picture;
-// - displayStudentProfile (display the student's profile in the DOM)
+    document.getElementById("tooltip-info-login").innerText = login;
-// - showModal (add a form modal to the DOM)
+    document.getElementById("tooltip-info-guild").innerText = guild;
+    document.getElementById("tooltip-info-quote").innerText = quote;
+}
+// add a form modal to the DOM
+function showModal() {}
+
+export { displayStudentProfile, showModal };

src/utils/auth.js

@@ -20,8 +20,12 @@ async function sendRequest(endpoint, body) {
 
     try {
         response = await fetch(endpoint, request);
-        if (!response.ok) {
+        if (!response || !response.ok) {
-            throw new Error(response.statusText);
+            if (response && response.statusText) {
+                throw new Error(response.statusText);
+            } else {
+                throw new Error("No status text");
+            }
         }
     } catch (err) {
         console.error(err);