register model at runtime by SzNagyMisu · Pull Request #511 · vuex-orm/vuex-orm

SzNagyMisu · 2019-12-02T13:00:54Z

PR for #187

90% done - stuck with remaining 10%...

I can register a brand new module into vuex (like 'entities/hobbies') but cannot add a new getter under an existing module (like the namespaced getter 'hobbies' under the module 'entities').

See L44-L46 in ModuleBuilder.createModules()

vuex-orm/src/modules/builder/Builder.ts

Lines 35 to 56 in a48dea1

    
           static createModules (tree: Module, namespace: string, models: Models, modules: Modules): Module { 
        
             Object.keys(modules).forEach((name) => { 
        
               const model = models[name] 
        
               const module = modules[name] 
        
               tree.modules[name] = { namespaced: true } 
        
               tree.modules[name].state = this.createState(namespace, name, model, module) 
        
               tree.getters[name] = (_state: RootState, getters: any, _rootState: any, _rootGetters: any) => () => { 
        
                 return getters.query(name) 
        
               } 
        
               tree.modules[name].getters = { ...Getters, ...module.getters } 
        
               tree.modules[name].actions = { ...Actions, ...module.actions } 
        
               tree.modules[name].mutations = module.mutations || {} 
        
             }) 
        
             return tree 
        
           }

Any ideas?
@kiaking what are that gettters for? I don't remember having met them in the docs or during coding.

kiaking · 2019-12-03T10:03:47Z

Ahh... yeah. That getter is so we can do store.getters['entities/users']() and get Query instance of User model. It's shortcut for store.getters['entities/users/query']().

Looking into Vuex doc, maybe there's no way to add extra getters after store initialization... As you mentioned, it's not documented so maybe we can just remove that functionality.

Do you think you can remove the test for that getter and make this PR pass?

Thank you so much for the PR by the way! 🎉

removed shorthand store.getters['entities/users']() for accessing query object of the model use the long version instead: store.getters['entities/users/query']()

codecov · 2019-12-03T15:29:21Z

Codecov Report

Merging #511 into master will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff          @@
##           master   #511   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          47     47           
  Lines        1798   1812   +14     
  Branches      250    252    +2     
=====================================
+ Hits         1798   1812   +14

Impacted Files	Coverage Δ
src/modules/builder/Builder.ts	`100% <100%> (ø)`	⬆️
src/database/Database.ts	`100% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a48dea1...1c2eaa9. Read the comment docs.

SzNagyMisu · 2019-12-03T15:30:50Z

+    const database = new Database()
+
+    database.register(User)
+    database.register(Hobby) // TODO custom module?


@kiaking
What do you think about testing this functionality with adding a custom module?

I think we should!

kiaking · 2019-12-23T11:20:33Z

@SzNagyMisu Hi sorry for my late response! Do you think you can resolve the conflict...!?

SzNagyMisu · 2020-01-02T08:15:03Z

Wow... Things have changed since... I'll give it a try

cf.: vuex-orm#511 (comment)

SzNagyMisu · 2020-01-02T09:51:18Z

I've decided it will be cleaner if I start the whole PR from scratch - so many things have changed since.

SzNagyMisu · 2020-01-02T09:54:16Z

Reopened PR at #535 - closing this one.

Szijjártó-Nagy Misu added 2 commits December 2, 2019 13:39

red: failing tests

2ba6119

almost green

6e468e3

kiaking added the enhancement New feature or request label Dec 3, 2019

making it all green

badb46e

removed shorthand store.getters['entities/users']() for accessing query object of the model use the long version instead: store.getters['entities/users/query']()

SzNagyMisu commented Dec 3, 2019

View reviewed changes

Szijjártó-Nagy Misu added 2 commits December 3, 2019 16:36

refactor

2ea714a

tests for registering models with modules

1c2eaa9

SzNagyMisu pushed a commit to SzNagyMisu/vuex-orm that referenced this pull request Jan 2, 2020

removing module.getters[entity.name]

1eb273f

cf.: vuex-orm#511 (comment)

SzNagyMisu mentioned this pull request Jan 2, 2020

register model at runtime #535

Merged

SzNagyMisu closed this Jan 2, 2020

SzNagyMisu deleted the 187-register-model-at-runtime branch February 3, 2020 13:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

register model at runtime#511

register model at runtime#511
SzNagyMisu wants to merge 5 commits into
vuex-orm:masterfrom
SzNagyMisu:187-register-model-at-runtime

SzNagyMisu commented Dec 2, 2019

Uh oh!

kiaking commented Dec 3, 2019

Uh oh!

codecov Bot commented Dec 3, 2019 •

edited

Loading

Uh oh!

SzNagyMisu Dec 3, 2019

Uh oh!

kiaking Dec 4, 2019

Uh oh!

SzNagyMisu Dec 9, 2019

Uh oh!

kiaking commented Dec 23, 2019

Uh oh!

SzNagyMisu commented Jan 2, 2020

Uh oh!

SzNagyMisu commented Jan 2, 2020

Uh oh!

SzNagyMisu commented Jan 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	static createModules (tree: Module, namespace: string, models: Models, modules: Modules): Module {
	Object.keys(modules).forEach((name) => {
	const model = models[name]
	const module = modules[name]

	tree.modules[name] = { namespaced: true }

	tree.modules[name].state = this.createState(namespace, name, model, module)

	tree.getters[name] = (_state: RootState, getters: any, _rootState: any, _rootGetters: any) => () => {
	return getters.query(name)
	}

	tree.modules[name].getters = { ...Getters, ...module.getters }

	tree.modules[name].actions = { ...Actions, ...module.actions }

	tree.modules[name].mutations = module.mutations \|\| {}
	})

	return tree
	}

Uh oh!

Conversation

SzNagyMisu commented Dec 2, 2019

Uh oh!

kiaking commented Dec 3, 2019

Uh oh!

codecov Bot commented Dec 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

SzNagyMisu Dec 3, 2019

Choose a reason for hiding this comment

Uh oh!

kiaking Dec 4, 2019

Choose a reason for hiding this comment

Uh oh!

SzNagyMisu Dec 9, 2019

Choose a reason for hiding this comment

Uh oh!

kiaking commented Dec 23, 2019

Uh oh!

SzNagyMisu commented Jan 2, 2020

Uh oh!

SzNagyMisu commented Jan 2, 2020

Uh oh!

SzNagyMisu commented Jan 2, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov Bot commented Dec 3, 2019 •

edited

Loading