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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose vue composition api through apiSpec (kolibri.lib.vueCompositionApi), so it is available to all SPAs #8146

Merged
merged 10 commits into from Jun 11, 2021

Conversation

jonboiser
Copy link
Contributor

@jonboiser jonboiser commented Jun 10, 2021

Summary

The original PR that brought Vue Composition did not properly install the plugin for all SPAs (for reasons I don't understand). However, if it is bundled into apiSpec and exposed via kolibri.lib.vueCompositionApi, it works 馃し

So this PR

  1. Makes kolibri.lib.vueCompositionApi the primary way to import Vue Composition API into your components
  2. Refactors Device, Coach, User, and Facility plugins to use the composition in a small way (to give us early warning if something goes wrong with the plugin)

References

This issue is blocking #8137 , since the current implementation makes heavy use of the composition API.

Reviewer guidance

Again, this refactor is a pretty straightforward mapping of Vue options -> composition functions, with a little sugar from vueuse/core. The app should work exactly as before.


Testing checklist

  • Contributor has fully tested the PR manually
  • [] If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@jonboiser jonboiser added the TAG: dev experience Build performance, linting, debugging... label Jun 10, 2021
@jonboiser jonboiser added this to the 0.15.0 milestone Jun 11, 2021
@jonboiser jonboiser merged commit adf80ee into learningequality:develop Jun 11, 2021
@jonboiser jonboiser deleted the composition-api-hacks branch June 11, 2021 17:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
TAG: dev experience Build performance, linting, debugging...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants