Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion client/shared
10 changes: 10 additions & 0 deletions client/src/App.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ import attGradeEffect from './entities/att-grade-effect';
import reportGroup from './entities/report-group';
import reportGroupSession from './entities/report-group-session';
import teacherReportedToday from './entities/teacher-reported-today';
import attendanceCleanupRule from './entities/attendance-cleanup-rule';
import Settings from 'src/settings/Settings';

import StudentAttendanceList from 'src/pivots/StudentAttendanceList';
Expand Down Expand Up @@ -93,6 +94,7 @@ import AdminPanelSettingsIcon from '@mui/icons-material/AdminPanelSettingsOutlin
import DirectionsBusIcon from '@mui/icons-material/DirectionsBusOutlined';
import CelebrationIcon from '@mui/icons-material/CelebrationOutlined';
import AssignmentTurnedInIcon from '@mui/icons-material/AssignmentTurnedInOutlined';
import CleaningServicesIcon from '@mui/icons-material/CleaningServicesOutlined';

const themeOptions = { primary: blue[700], secondary: purple[500] };

Expand Down Expand Up @@ -284,6 +286,14 @@ const App = () => (
options={{ menuGroup: 'settings' }}
icon={CalculateIcon}
/>
{isAdmin(permissions) && (
<Resource
name="attendance_cleanup_rule"
{...attendanceCleanupRule}
options={{ menuGroup: 'settings' }}
icon={CleaningServicesIcon}
/>
)}
<Resource
name="student_by_year"
{...(isAdmin(permissions) ? resourceEntityGuesser : {})}
Expand Down
15 changes: 15 additions & 0 deletions client/src/domainTranslations.js
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,21 @@ export default {
effectPercent: 'השפעה באחוזים',
},
},
attendance_cleanup_rule: {
name: 'כלל ניקוי נוכחות |||| כללי ניקוי נוכחות',
fields: {
...generalResourceFieldsTranslation,
name: 'שם הכלל',
lessonReferenceId: 'שיעור לניקוי',
klassReferenceId: 'כיתה/מסלול לשמירה',
dayOfWeek: 'יום בשבוע',
weeksBack: 'שבועות אחורה',
active: 'פעיל?',
},
actions: {
runNow: 'הרץ עכשיו',
},
},
grade_effect_by_user: {
name: 'קשר נוכחות ציון מורחב',
fields: {
Expand Down
105 changes: 105 additions & 0 deletions client/src/entities/attendance-cleanup-rule.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
import {
BooleanField,
BooleanInput,
DateField,
FunctionField,
maxValue,
minValue,
NumberField,
NumberInput,
ReferenceField,
required,
SelectInput,
TextField,
TextInput,
} from 'react-admin';
import { CommonDatagrid } from '@shared/components/crudContainers/CommonList';
import { CommonRepresentation } from '@shared/components/CommonRepresentation';
import { getResourceComponents } from '@shared/components/crudContainers/CommonEntity';
import CommonReferenceInput from '@shared/components/fields/CommonReferenceInput';
import { CommonReferenceInputFilter, filterByUserId } from '@shared/components/fields/CommonReferenceInputFilter';
import { commonAdminFilters } from '@shared/components/fields/PermissionFilter';
import { BulkActionButton } from '@shared/components/crudContainers/BulkActionButton';

const dayOfWeekChoices = [
{ id: 0, name: 'ראשון' },
{ id: 1, name: 'שני' },
{ id: 2, name: 'שלישי' },
{ id: 3, name: 'רביעי' },
{ id: 4, name: 'חמישי' },
{ id: 5, name: 'שישי' },
{ id: 6, name: 'שבת' },
];

const filters = [
...commonAdminFilters,
<TextInput source="name:$cont" alwaysOn />,
<CommonReferenceInputFilter source="lessonReferenceId" reference="lesson" dynamicFilter={filterByUserId} />,
];

const Datagrid = ({ isAdmin, children, ...props }) => {
const additionalBulkButtons = [
<BulkActionButton key="runNow" label="הרץ עכשיו" name="runNow" reloadOnEnd />,
];

return (
<CommonDatagrid {...props} additionalBulkButtons={additionalBulkButtons}>
{children}
{isAdmin && <TextField source="id" />}
<TextField source="name" />
<ReferenceField source="lessonReferenceId" reference="lesson" />
<ReferenceField source="klassReferenceId" reference="klass" />
<FunctionField
source="dayOfWeek"
render={(record) => dayOfWeekChoices.find((c) => c.id === record.dayOfWeek)?.name}
/>
<NumberField source="weeksBack" />
<BooleanField source="active" />
{isAdmin && <DateField showDate showTime source="createdAt" />}
</CommonDatagrid>
);
};

const Inputs = ({ isCreate, isAdmin }) => {
return (
<>
{!isCreate && isAdmin && <TextInput source="id" disabled />}
{isAdmin && <CommonReferenceInput source="userId" reference="user" validate={required()} />}
<TextInput source="name" helperText="שם לזיהוי הכלל, לדוגמה: ניקוי תפילה יום חמישי" />
<CommonReferenceInput
source="lessonReferenceId"
reference="lesson"
dynamicFilter={filterByUserId}
validate={required()}
helperText="השיעור שינוקה"
/>
<CommonReferenceInput
source="klassReferenceId"
reference="klass"
dynamicFilter={filterByUserId}
validate={required()}
helperText="הכיתה/מסלול שישמר - הנוכחות תימחק לכל שאר הכיתות"
/>
<SelectInput source="dayOfWeek" choices={dayOfWeekChoices} validate={required()} />
<NumberInput
source="weeksBack"
defaultValue={2}
min={1}
max={52}
step={1}
validate={[required(), minValue(1), maxValue(52)]}
helperText="כמה שבועות אחורה לנקות בכל הרצה (1-52)"
/>
<BooleanInput source="active" defaultValue={true} />
</>
);
};

const entity = {
Datagrid,
Inputs,
Representation: CommonRepresentation,
filters,
};

export default getResourceComponents(entity);
1 change: 1 addition & 0 deletions client/src/roadmapFeatures.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ export default [
{ html: 'הוספת דוח המציג אילו מורות דיווחו נוכחות בתאריך נבחר', status: 'בוצע', statusColor: 'success' },
{ html: 'הוספת דף "צור קשר" לשליחת פנייה עם קבצים מצורפים', status: 'בוצע', statusColor: 'success' },
{ html: 'תשתית משימות רקע: ייצוא נתונים אסינכרוני, תזמונים קבועים וניטור משימות', status: 'בוצע', statusColor: 'success' },
{ html: 'ניקוי אוטומטי של נוכחות שיעור נבחר, לפי כיתה/מסלול לשמירה, בכל מוצאי שבת', status: 'בוצע', statusColor: 'success' },

// { html: 'הגדרת תקופת זמן לפי תאריכים', status: 'בקרוב', statusColor: 'warning' },
// { html: 'הגדרת תקופת זמן לפי יום בשבוע', status: 'בוצע', statusColor: 'success' },
Expand Down
2 changes: 1 addition & 1 deletion server/shared
2 changes: 2 additions & 0 deletions server/src/app.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ import { BaseNraAppModule } from '@shared/app/base-app.module';
import { EntitiesModule } from './entities.module';
import { UserInitModule } from './user-init.module';
import { YemotHandlerService } from './yemot-handler.service';
import { AttendanceCleanupSweepHandler } from './jobs/attendance-cleanup-sweep.handler';

export const AppModule = BaseNraAppModule.forRoot({
entitiesModule: EntitiesModule,
yemotHandlerService: YemotHandlerService,
userInitModule: UserInitModule,
throttlerLimit: 200,
jobHandlers: [AttendanceCleanupSweepHandler],
});
129 changes: 129 additions & 0 deletions server/src/db/entities/AttendanceCleanupRule.entity.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
import {
BeforeInsert,
BeforeUpdate,
Column,
DataSource,
Entity,
Index,
JoinColumn,
ManyToOne,
PrimaryGeneratedColumn,
} from 'typeorm';
import { IHasUserId } from '@shared/base-entity/interface';
import { BooleanIntColumn } from '@shared/utils/entity/column-types.util';
import { findOneAndAssignKey, getDataSource } from '@shared/utils/entity/foreignKey.util';
import { IsOptional } from 'class-validator';
import { CrudValidationGroups } from '@dataui/crud';
import { IsNotEmpty, IsNumber, MaxLength, Max, Min } from '@shared/utils/validation/class-validator-he';
import { StringType, NumberType } from '@shared/utils/entity/class-transformer';
import { CreatedAtColumn, UpdatedAtColumn } from '@shared/utils/entity/column-types.util';
import { Lesson } from './Lesson.entity';
import { Klass } from './Klass.entity';
import { User } from './User.entity';

/**
* A recurring attendance-cleanup rule: on `dayOfWeek`, delete att_reports for
* every student who does NOT belong to `klassId` (the klass/track to
* preserve, via student_klasses membership — NOT att_reports' own
* klassReferenceId, which is the report/session's klass and the same for
* everyone in it), for each of the last `weeksBack` occurrences of that
* weekday. Consumed weekly by the attendance-cleanup-sweep job handler.
*
* Deliberately has no `year` column, unlike Lesson/Klass/AttReport/
* StudentKlass — a rule is meant to keep working across academic years.
* The form picks lessonReferenceId/klassReferenceId (this year's row, via a
* friendly dropdown); fillFields below resolves those DOWN to the
* underlying Lesson.key/Klass.key (stable across years) and persists the
* key, not the one-year id. The sweep re-resolves key -> that target date's
* own academic year's id at run time, so the rule doesn't go stale when a
* new year's Lesson/Klass/StudentKlass rows get created with fresh ids.
*/
@Index('attendance_cleanup_rules_users_idx', ['userId'], {})
@Entity('attendance_cleanup_rules')
export class AttendanceCleanupRule implements IHasUserId {
@BeforeInsert()
@BeforeUpdate()
async fillFields() {
let dataSource: DataSource;
try {
dataSource = await getDataSource([Lesson, Klass, User]);

this.lessonId = await findOneAndAssignKey(dataSource, Lesson, this.userId, this.lessonReferenceId, this.lessonId);
this.klassId = await findOneAndAssignKey(dataSource, Klass, this.userId, this.klassReferenceId, this.klassId);
} finally {
dataSource?.destroy();
}
}

@PrimaryGeneratedColumn({ type: 'int', name: 'id' })
id: number;

@Column('int', { name: 'user_id' })
userId: number;

@IsOptional({ always: true })
@StringType
@MaxLength(255, { always: true })
@Column('varchar', { name: 'name', length: 255, nullable: true })
name: string | null;

@IsNotEmpty({ groups: [CrudValidationGroups.CREATE] })
@IsOptional({ groups: [CrudValidationGroups.UPDATE] })
@Column({ nullable: true })
lessonReferenceId: number;

/** Lesson.key, derived from lessonReferenceId in fillFields — not user-editable. */
@IsOptional({ always: true })
@NumberType
@IsNumber({ maxDecimalPlaces: 0 }, { always: true })
@Column('int', { name: 'lesson_id', nullable: true })
lessonId: number;

/** The track/class to PRESERVE (checked via student_klasses membership, not att_reports.klassReferenceId). */
@IsNotEmpty({ groups: [CrudValidationGroups.CREATE] })
@IsOptional({ groups: [CrudValidationGroups.UPDATE] })
@Column({ nullable: true })
klassReferenceId: number;

/** Klass.key, derived from klassReferenceId in fillFields — not user-editable. */
@IsOptional({ always: true })
@NumberType
@IsNumber({ maxDecimalPlaces: 0 }, { always: true })
@Column('int', { name: 'klass_id', nullable: true })
klassId: number;

/** 0=Sunday .. 6=Saturday (JS Date.getDay() convention). */
@IsNotEmpty({ groups: [CrudValidationGroups.CREATE] })
@IsOptional({ groups: [CrudValidationGroups.UPDATE] })
@NumberType
@IsNumber({ maxDecimalPlaces: 0 }, { always: true })
@Min(0, { always: true })
@Max(6, { always: true })
@Column('int', { name: 'day_of_week' })
dayOfWeek: number;

@IsOptional({ always: true })
@NumberType
@IsNumber({ maxDecimalPlaces: 0 }, { always: true })
@Min(1, { always: true })
@Max(52, { always: true })
@Column('int', { name: 'weeks_back', default: 2 })
weeksBack: number;

@BooleanIntColumn({ default: true })
active: boolean;

@CreatedAtColumn()
createdAt: Date;

@UpdatedAtColumn()
updatedAt: Date;

@ManyToOne(() => Lesson, { createForeignKeyConstraints: false })
@JoinColumn({ name: 'lessonReferenceId' })
lesson: Lesson;

@ManyToOne(() => Klass, { createForeignKeyConstraints: false })
@JoinColumn({ name: 'klassReferenceId' })
klass: Klass;
}
2 changes: 2 additions & 0 deletions server/src/entities.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import absenceTypeConfig from './entity-modules/absenceType.config';
import uploadedFileConfig from '@shared/entities/configs/uploaded-file.config';
import phoneTemplateConfig from '@shared/entities/configs/phone-template.config';
import phoneCampaignConfig from '@shared/entities/configs/phone-campaign.config';
import attendanceCleanupRuleConfig from './entity-modules/attendance-cleanup-rule.config';
import { Student } from './db/entities/Student.entity';
import { Teacher } from './db/entities/Teacher.entity';
import userConfig from '@shared/entities/configs/user.config';
Expand Down Expand Up @@ -99,6 +100,7 @@ registerEntityNameMap({
BaseEntityModule.register(phoneTemplateConfig),
BaseEntityModule.register(phoneCampaignConfig),
BaseEntityModule.register({ entity: TeacherReportedToday }),
BaseEntityModule.register(attendanceCleanupRuleConfig),
],
})
export class EntitiesModule {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import { CrudRequest } from '@dataui/crud';
import { AttendanceCleanupRule } from 'src/db/entities/AttendanceCleanupRule.entity';
import attendanceCleanupRuleConfig from '../attendance-cleanup-rule.config';

describe('AttendanceCleanupRuleConfig', () => {
it('should have correct base configuration', () => {
expect(attendanceCleanupRuleConfig.entity).toBe(AttendanceCleanupRule);
expect(attendanceCleanupRuleConfig.query.join).toEqual(
expect.objectContaining({
lesson: { eager: false },
klass: { eager: false },
}),
);
expect(attendanceCleanupRuleConfig.service).toBeDefined();
});

describe('doAction: runNow', () => {
function makeService() {
const ServiceClass = attendanceCleanupRuleConfig.service as any;
const mockRepository = {
target: AttendanceCleanupRule,
manager: { transaction: jest.fn((cb) => cb()) },
metadata: {
columns: [{ propertyName: 'id' }, { propertyName: 'userId' }],
connection: { options: { type: 'mysql' } },
targetName: 'AttendanceCleanupRule',
},
} as any;
const jobService = { enqueue: jest.fn().mockResolvedValue({ id: 42 }) };
const service = new ServiceClass(mockRepository, {} as any, jobService);
return { service, jobService };
}

it('enqueues an attendance-cleanup-sweep job scoped to the selected rule ids', async () => {
const { service, jobService } = makeService();
const req = {
auth: { id: 7 },
parsed: { extra: { action: 'runNow', ids: '1,2' } },
} as unknown as CrudRequest;

const message = await service.doAction(req, {});

expect(jobService.enqueue).toHaveBeenCalledWith(7, 'attendance-cleanup-sweep', { ruleIds: [1, 2] });
expect(message).toContain('42');
});

it('falls through to the base doAction for unknown actions', async () => {
const { service } = makeService();
const req = {
auth: { id: 7 },
parsed: { extra: { action: 'somethingElse' } },
} as unknown as CrudRequest;

const result = await service.doAction(req, {});
expect(result).toBe('done nothing');
});
});
});
Loading
Loading