Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Improve description entrypoint #423

Merged
merged 2 commits into from Sep 29, 2021

Conversation

erikmd
Copy link
Member

@erikmd erikmd commented Sep 26, 2021

This 2-commits PR builds upon #393; which should be merged before merging this one, #423 (with an optional rebase).

This PR implements the following item mentioned in #418:

  • Dev base64 encoding for /description endpoint URL
    (following an idea discussed with @yurug some weeks ago)

It also incorporates a change (separate commit) to improve the /description UI/UX a bit regarding loading time,
and error rendering:

2021-09-26_21-57-48_Screenshot_description_missing_token

@erikmd erikmd added the kind: enhancement Enhancement to an existing user-facing feature. label Sep 26, 2021
@erikmd erikmd requested a review from yurug September 26, 2021 19:51
@erikmd erikmd added this to the learn-ocaml 0.13 milestone Sep 26, 2021
@erikmd erikmd added the needs: merge of dependency This PR depends on another PR being merged first. label Sep 27, 2021
* in order to have as good an UX as that of exercises view
* Aim: interoperate with learn-ocaml.el, which can encode the token by

  (base64-encode-string (format "%192s" "AAA-BBB-CCC-DDD") t)

  before opening the URL

  http://localhost:8080/description/:id#token1=:encoded

  with a 256-wide string for ":encoded" that couldn't be easily copied
  if, say, the user takes a screenshot of the exercise description.

* For the moment, the support of legacy URLs

  http://localhost:8080/description/:id#token=AAA-BBB-CCC-DDD

  is still supported (but deprecated; it may be removed later on).
@yurug yurug merged commit a825d7e into ocaml-sf:master Sep 29, 2021
@erikmd erikmd deleted the improve-description branch September 30, 2021 14:29
@erikmd erikmd removed the needs: merge of dependency This PR depends on another PR being merged first. label Oct 2, 2021
erikmd added a commit to pfitaxel/learn-ocaml that referenced this pull request Oct 3, 2021
* feat(description): Add learnocaml-exo-loading initial phase

* in order to have as good an UX as that of exercises view

* feat(description): Implement padding decoding

* Aim: interoperate with learn-ocaml.el, which can encode the token by

  (base64-encode-string (format "%192s" "AAA-BBB-CCC-DDD") t)

  before opening the URL

  http://localhost:8080/description/:id#token1=:encoded

  with a 256-wide string for ":encoded" that couldn't be easily copied
  if, say, the user takes a screenshot of the exercise description.

* For the moment, the support of legacy URLs

  http://localhost:8080/description/:id#token=AAA-BBB-CCC-DDD

  is still supported (but deprecated; it may be removed later on).
erikmd added a commit to pfitaxel/learn-ocaml.el that referenced this pull request Oct 3, 2021
* (learn-ocaml-compute-questions-url):
  Add learn-ocaml-compute-questions-url-token1-compat
  to implement the elisp counterpart of PR
  <ocaml-sf/learn-ocaml#423>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: enhancement Enhancement to an existing user-facing feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants