Note additions #386

Schottkyc137 · 2019-12-11T15:02:39Z

see issue: #221, #381, #145

Visible/Frontend Changes

Meeting Notes now have a table of children that were present/absent
Users can choose whether a child was present or absent and set remarks
This table is suitable for small screens as well as big screens
The absence/presence of a single child will be reflected by suitable colors in the child's notes-list component
The Note-Manager-component uses a paginator

Architectural/Backend Changes

Note now is now it's own module and is no longer a sub-component of the ChildrenModule
A NotesService has been implemented to fetch resources from the EntityMapper and distribute updates throughout every listening component
Minor changes have been made to the EntitySubrecord and ChildSelect-components to enable these new features
Demo-Data now also incorporates a generator for meeting-notes where certain children are marked as absent/present with suitable remarks

…ad of just one and added a notes service to provide the notes-data throughout the app

…at are part of a meeting

…odel for the children in a group-note

…de a note

…than those that were present + fixed a bug where a note would be in the note component multiple times after saving

…than those that were present

# Conflicts: # src/app/children/children.service.spec.ts # src/app/children/notes/note-details/note-details.component.html # src/app/children/notes/note-details/note-details.component.scss # src/app/children/notes/notes-manager/notes-manager.component.ts # src/app/session/connection-state.enum.ts # src/app/session/database.service.provider.ts # src/app/session/local-session.ts # src/app/session/login-state.enum.ts # src/app/session/mock-session.service.ts # src/app/session/remote-session.ts # src/app/session/session.service.provider.ts # src/app/session/session.service.ts # src/app/session/sync-state.enum.ts # src/app/session/synced-session.service.spec.ts # src/app/session/synced-session.service.ts # src/app/session/util/state-handler.spec.ts # src/app/session/util/state-handler.ts

sleidig · 2020-01-22T21:57:56Z

sorry for the merge conflicts with the master branch, this will be mostly due to the moving of files into a new folder structure (#394).

Is this otherwise complete and ready for review and merge?

Schottkyc137 · 2020-01-22T22:34:23Z

Concerning features and other changes, this is done.
Currently, I'm only working on improving the test coverage & fixing other codeclimate errors

…hools # Conflicts: # src/app/child-dev-project/children/child-details/child-details.component.spec.ts # src/app/child-dev-project/children/children.module.ts # src/app/child-dev-project/children/model/childSchoolRelation.ts # src/app/child-dev-project/children/view-schools-component/edit-school-dialog/edit-school-dialog.component.html # src/app/child-dev-project/children/view-schools-component/edit-school-dialog/edit-school-dialog.component.spec.ts # src/app/child-dev-project/children/view-schools-component/edit-school-dialog/edit-school-dialog.component.ts # src/app/child-dev-project/children/view-schools-component/view-schools.component.html # src/app/child-dev-project/children/view-schools-component/view-schools.component.scss # src/app/child-dev-project/children/view-schools-component/view-schools.component.ts # src/app/child-dev-project/notes/note-details/note-details.component.html # src/app/child-dev-project/notes/notes-component/notes.component.spec.ts # src/app/child-dev-project/schools/model/schoolWithRelation.ts # src/app/core/entity/schema/entity-schema.service.ts # src/app/core/ui-helper/entity-subrecord/entity-subrecord.component.html # src/app/core/ui-helper/entity-subrecord/entity-subrecord.component.ts

# Conflicts: # src/app/child-dev-project/children/child-details/child-details.component.spec.ts # src/app/child-dev-project/children/children.module.ts # src/app/child-dev-project/notes/note-details/note-details.component.html # src/app/child-dev-project/notes/notes-component/notes.component.spec.ts # src/app/core/entity/schema/entity-schema.service.ts # src/app/core/ui-helper/entity-subrecord/entity-subrecord.component.html # src/app/core/ui-helper/entity-subrecord/entity-subrecord.component.ts

sleidig

This is great functionality (you seem to have thought about every related aspect!) and the code looks really good already 👍
Please have a look at my few remaining comments and questions.

Functional testing went well. However, I see a few points where we could still polish for UX:

I think the child-select and the presence list elements should be directly next to each other (maybe move the child-select down, above the presence list). That will make it easier for new users to understand the connection.
How to switch children between present/absent is not obvious for non-technical users. We could try whether a toggle [Present|Absent] instead of the arrow makes it more transparent. Or maybe you have other ideas?
Meeting notes are very highlighted in the Notes section of the Child Details view currently, because most other Notes just have white background. I'm not sure how to improve that easily however and don't think this is a blocker. But maybe you have any ideas?

sleidig · 2020-02-11T19:58:17Z

src/app/child-dev-project/children/child-select/child-select.component.ts

@@ -57,7 +59,7 @@ export class ChildSelectComponent implements OnInit {
  selectChild(child: Child, suppressChangeEvent = false) {
    this.selectedChildren.push(child);
    if (!suppressChangeEvent) {
-      this.valueAsIdsChange.emit(this.selectedChildren.map(c => c.getId()));


the EventEmitter named valueAsIdsChange is important to allow two-way databinding (details) on the property valueAsIds (if you can think of a better name, please suggest a rename!). We should keep the emit() for that as well and have both outputs in parallel, I think.

sleidig · 2020-02-11T20:00:40Z

src/app/child-dev-project/children/children.service.ts

@@ -4,7 +4,7 @@ import { Child } from './model/child';
 import { EntityMapperService } from '../../core/entity/entity-mapper.service';
 import { AttendanceMonth } from '../attendance/model/attendance-month';
 import { Database } from '../../core/database/database';
-import { Note } from '../notes/model/note';
+import { NoteModel } from '../notes/note.model';


Any particular reason to rename the Note class to NoteModel? I think we should keep this consistent for all Entity classes and personally favour the short Note but we can put this up for discussion

I have done this to distinguish the new NoteModel from the old Note during refactoring from a component to a module. I kept the change to make it clear that this was a model. Since I agree that this is no longer needed, I will revert the changes

sleidig · 2020-02-11T20:06:52Z

src/app/child-dev-project/children/notes-list/notes-list.component.ts

-      this.childrenService.getNotesOfChild(this.childId)
-        .subscribe(results => this.records = results.sort((a, b) => {
-          return (b.date ? b.date.valueOf() : 0) - (a.date ? a.date.valueOf() : 0); } ));
+    this.entityMapperService.loadType<NoteModel>(NoteModel).then(notes => {


Loading every note and doing in-memory filtering may become a performance issue. ChildrenService.getNotesOfChild() uses a pouchdb database index and should (in theory) be the better choice.

Did you have any particular issues that pushed you to change this here?

I had an issue with this but could resolve this in another way. Until now I thought that these two ways of getting the data were equal in performance. If that's not the case, I will revert these changes as well

Looking at the code right now, the issue was not resolved. ChildrenService filters if the children-array of the Note contains the child-id (which is never true since the Array is of type AttendanceModel). Is it possible to change the database quarry to check if any of it's AttendanceModels contains the id?

For the PouchDb/CouchDB based Database queries should be more efficient, the database then only loads the required documents and returns them (and hopefully the developers of pouchdb have figured out a way to do that reasonably efficient).

The query index is also created in the ChildrenService:

ndb-core/src/app/child-dev-project/children/children.service.ts

Lines 229 to 243 in 134d808

private createNotesIndex(): Promise<any> {

const designDoc = {

_id: '_design/notes_index',

views: {

by_child: {

map: '(doc) => { ' +

'if (!doc._id.startsWith("' + Note.ENTITY_TYPE + '")) return;' +

'doc.children.forEach(childId => emit(childId)); ' +

'}',

},

},

};

return this.db.saveDatabaseIndex(designDoc);

}

Beware, unfortunately the function has to be a string containing the javascript function (to prevent the build optimization from messing this up). You can also refer to the PouchDB guide about how those query functions work: https://pouchdb.com/guides/queries.html

Basically you'll just have to change that function to emit() the childId from its new nested place.

sleidig · 2020-02-11T20:08:56Z

src/app/child-dev-project/notes/attendance.model.ts

@@ -0,0 +1,21 @@
+
+export class AttendanceModel {


This sounds very similar to our AttendanceMonth class and the (completely separate) system for keeping students' school attendance. Maybe MeetingNoteAttendance or something like that can make its purpose more clear?

sleidig · 2020-02-11T20:20:46Z

src/app/child-dev-project/notes/note-detail/note-detail.component.html

+    <!--Small screen: display the notes in tabs-->
+    <div *ngIf="entity.isMeeting() && smallScreen" fxLayout="row wrap" fxLayoutGap="20px">
+
+      <mat-tab-group mat-align-tabs="center" fxFlex>
+        <mat-tab label="Present" class="padding-container" >
+          <app-child-presence-list [note]="entity" [recordForm]="recordForm" [present]="true" fxFlex></app-child-presence-list>
+        </mat-tab>
+        <mat-tab label="Absent" class="padding-container" >
+          <app-child-presence-list [note]="entity" [recordForm]="recordForm" [present]="false" fxFlex></app-child-presence-list>
+        </mat-tab>
+      </mat-tab-group>
+
+    </div>
+
+    <!--Big screen: display the notes as two lists-->
+    <div *ngIf="entity.isMeeting() && !smallScreen" fxLayout="row wrap" fxLayoutGap="20px">
+      <app-child-presence-list [note]="entity"
+                               [recordForm]="recordForm"
+                               [present]="true"
+                               [label]="'Present'"
+                               class="padding-bottom"
+                               fxFlex>
+      </app-child-presence-list>
+      <app-child-presence-list [note]="entity"
+                               [recordForm]="recordForm"
+                               [present]="false"
+                               [label]="'Absent'"
+                               class="padding-bottom"
+                               fxFlex>
+      </app-child-presence-list>
+    </div>


Let's extract this into a separate component as well so the responsive version can be easily re-used (and the template here will be shorter and more manageable). Possibly such a new component could also include the app-child-select component above and be somewhat of an alternative to the simple app-child-select

src/app/core/ui-helper/AbstractDetailsComponent.ts

…hools # Conflicts: # src/app/core/admin/export-data/export-data.component.html

…ote-additions

sleidig · 2020-04-22T07:15:33Z

closing this as PR #431 is built upon this branch

…e previous schools better closes #145 closes #317 closes #398 see PRs #431 and #386 Co-authored-by: Schottkyc137 <lukas2121@icloud.com> Co-authored-by: Sebastian Leidig <sebastian.leidig@gmail.com> Co-authored-by: Christoph Scheuing <cs@iMac-von-Christoph.local>

Schottkyc137 added 21 commits November 26, 2019 21:52

Changed the children in notes to use an array with three fields inste…

9e8a9e5

…ad of just one and added a notes service to provide the notes-data throughout the app

Refactored InteractionTypes to be an enum

212988b

Added a rudimentary ui to display the presence/absence of children th…

3540ddc

…at are part of a meeting

Improvements to the Child absent/present-table ui and the notes-service

b437d65

Added specific emitters for removing/adding a child from a note

7ca3b18

Added functionality to the demo generator to generate an attendance-m…

aef162e

…odel for the children in a group-note

Fixed a bug where the remarks would be the same for all children insi…

71f3eb2

…de a note

Children that were absent will now be displayed in a different color …

ecccf2b

…than those that were present + fixed a bug where a note would be in the note component multiple times after saving

Children that were absent will now be displayed in a different color …

9c45495

…than those that were present

Refactored the absence-list and presence-list into reusable components

7fd0801

Optimized the child-presence list for small screens

9effb00

Added bottom padding to the child-presence list

db9af9c

Update AttendanceModel correct if the fetched data is outdated

eafaa69

Added a Paginator for the Note-Manager

a5a699a

Update to newest version

0b603dc

Update to newest version

43e719d

Update to newest version

6d41e43

moved the tests from note-service to the note-manager

4b5fe69

fixed typos

a11bee5

replaced raw note.children accesses with suitable methods

8621f2d

Schottkyc137 changed the title ~~[WIP] Note additions~~ Note additions Dec 18, 2019

Schottkyc137 added 6 commits December 18, 2019 21:21

fixed spurious error messages

ce7694d

fixed missing semicolon

97a31d9

Refactored two similar detailComponents to use one common super-class

6d2168c

Reworked old tests

9814314

fixed ng-lint errors

4a0e3bc

fixed tests, removed NoteService

2543805

Schottkyc137 and others added 8 commits February 4, 2020 20:28

Added test cases and comments

a562286

removed private modifiers

53e15cd

merged into master

c1c9c3e

merged into master

35157cb

fix color-coding of other entities based on WarningLevel

9d49366

merged into master

838dc22

sleidig requested changes Feb 11, 2020

View reviewed changes

sleidig and others added 14 commits February 11, 2020 21:50

adapt note colors to general color scheme

106961c

minor tweaks

c302243

Merge remote-tracking branch 'remotes/origin/master' into previous-sc…

dafbef9

…hools # Conflicts: # src/app/core/admin/export-data/export-data.component.html

Merge remote-tracking branch 'remotes/origin/master' into note-additions

26afb28

Merge remote-tracking branch 'origin/note-additions' into note-additions

f23e796

Note presence list refactored into own component

df59c14

Merge remote-tracking branch 'remotes/origin/previous-schools' into n…

8242a9e

…ote-additions

Note presence list refactored into own component

cce76de

Fixed presence list not visible

8f80b0b

re-added valueAsIdsChange emitter

547d5b5

changed 'attendancemodel' to 'meetingnoteattendance'

ba581ee

changed 'attendancemodel' to 'meetingnoteattendance'

c682cc1

Merge remote-tracking branch 'remotes/origin/master' into note-additions

0389c83

merged into master and fixed test

304b75b

christophscheuing mentioned this pull request Apr 22, 2020

Note Additions + Child school relations update #431

Merged

3 tasks

sleidig closed this Apr 22, 2020

sleidig reopened this Apr 22, 2020

sleidig closed this Apr 22, 2020

sleidig deleted the note-additions branch April 22, 2020 07:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Note additions #386

Note additions #386

Schottkyc137 commented Dec 11, 2019 •

edited

Loading

sleidig commented Jan 22, 2020

Schottkyc137 commented Jan 22, 2020

sleidig left a comment •

edited

Loading

sleidig Feb 11, 2020

sleidig Feb 11, 2020

Schottkyc137 Feb 11, 2020

sleidig Feb 11, 2020

Schottkyc137 Feb 11, 2020

Schottkyc137 Feb 11, 2020

sleidig Feb 12, 2020

sleidig Feb 11, 2020

sleidig Feb 11, 2020

sleidig commented Apr 22, 2020

	private createNotesIndex(): Promise<any> {
	const designDoc = {
	_id: '_design/notes_index',
	views: {
	by_child: {
	map: '(doc) => { ' +
	'if (!doc._id.startsWith("' + Note.ENTITY_TYPE + '")) return;' +
	'doc.children.forEach(childId => emit(childId)); ' +
	'}',
	},
	},
	};

	return this.db.saveDatabaseIndex(designDoc);
	}

Note additions #386

Note additions #386

Conversation

Schottkyc137 commented Dec 11, 2019 • edited Loading

Visible/Frontend Changes

Architectural/Backend Changes

sleidig commented Jan 22, 2020

Schottkyc137 commented Jan 22, 2020

sleidig left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sleidig commented Apr 22, 2020

Schottkyc137 commented Dec 11, 2019 •

edited

Loading

sleidig left a comment •

edited

Loading