publiclab/mapknitter

Follow-up fixes to synchronous editing

Open

#1,097 opened on Oct 18, 2019

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)Ruby (203 forks)auto 404
bughelp wanted

Repository metrics

Stars
 (274 stars)
PR merge metrics
 (PR metrics pending)

Description

Noting some suggested fixes/next steps to get synchronous editing working, from this comment by @sashadev-sky -- https://github.com/publiclab/mapknitter/pull/959#issuecomment-530625451

Live synchronous editing will not work I am fairly sure. The code itself has a lot of bugs and it throws errors. Also a lot of code smells, it recopied the code in Map.js that was there before I updated it here.

Mainly, heres the most problematic part: https://github.com/publiclab/mapknitter/blob/bdab16c0bb119700037198e0cb576b3d1d5519da/app/assets/javascripts/mapknitter/Map.js#L512-L528

The data parameter passed to the success function is always just going to be "success". Then in later functions this parameter is assumed to be a warpable.

If i were to try to fix this, how would I test synchronous editing? Not familiar with how this works

To illustrate how it is supposed to work, check out this comment by @ViditChitkara !

https://github.com/publiclab/mapknitter/pull/805#issuecomment-513361816

and https://github.com/publiclab/mapknitter/pull/957

Here's an in-progress GIF -- some bugs with it have already been fixed, but it shows how to test the system:

Contributor guide

Research direction
Inspect the referenced code block in Map.js (lines 512-528) and understand how synchronous editing is supposed to work from the linked PRs #805 and #957. Trace the data flow to identify why the 'data' parameter is always 'success' instead of a warpable object.
Tech stack
rubyjavascriptrails
Domain
frontendbackend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitRuby on Rails
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50