Issue/493 Study Tags

.github/workflows/supabase-test.yml

@@ -0,0 +1,49 @@
+name: Test Supabase
+on:
+  push:
+    paths:
+      - "database/**"
+      - "docker/**"
+  pull_request:
+    paths:
+      - "database/**"
+      - "docker/**"
+  workflow_dispatch:
+
+jobs:
+  pgtap:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: supabase/postgres:15.1.0.90
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Seed database
+        run: cp database/studyu-schema.sql docker/supabase/seed.sql
+
+      - name: Set up Supabase CLI
+        uses: supabase/setup-cli@v1
+        with:
+          version: latest
+
+      - name: Initialize Supabase
+        working-directory: docker
+        run: |
+          supabase db start
+
+      - name: Run Supabase Tests
+        working-directory: docker
+        run: |
+          supabase test db

CONTRIBUTING.md

@@ -63,10 +63,8 @@ convenience:
 
 - `.env`: Production database used by default
 - `.env.staging`: Staging database, currently not ready to be used
-- `.env.local`: Used to run StudyU locally with Docker with the deployed
-  production instance of Supabase
-- `.env.selfhost`: Used for a selfhosted instance of Supabase, e.g. an instance
-  running locally with Docker
+- `.env.local`: Used to run StudyU locally with Docker
+- `.env.hpi`: Used for a selfhost instance of Supabase at HPI
 
 Ideally we should only use the staging database or a local one for all our
 development work.

app/lib/screens/study/report/sections/average_section_widget.dart

@@ -186,10 +186,13 @@ class AverageSectionWidget extends ReportSectionWidget {
                 showTitles: true,
                 getTitlesWidget: getTitles,
               )),
+          // ignore: prefer_const_constructors
           topTitles: AxisTitles(
+              // ignore: prefer_const_constructors
               sideTitles: SideTitles(
             showTitles: false,
           ))),
+      // ignore: prefer_const_constructors
       gridData: charts.FlGridData(
         drawHorizontalLine: false,
         drawVerticalLine: false,

app/pubspec.lock

@@ -373,14 +373,6 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "0.10.2"
-  freezed_annotation:
-    dependency: transitive
-    description:
-      name: freezed_annotation
-      sha256: "70776c4541e5cacfe45bcaf00fe79137b8c61aa34fb5765a05ce6c57fd72c6e9"
-      url: "https://pub.dev"
-    source: hosted
-    version: "0.14.3"
   functions_client:
     dependency: transitive
     description:

core/lib/src/models/models.dart

@@ -16,5 +16,8 @@ export 'tables/repo.dart';
 export 'tables/study.dart';
 export 'tables/study_invite.dart';
 export 'tables/study_subject.dart';
+export 'tables/study_tag.dart';
 export 'tables/subject_progress.dart';
+export 'tables/tag.dart';
+export 'tables/user.dart';
 export 'tasks/tasks.dart';

core/lib/src/models/tables/repo.dart

@@ -22,9 +22,9 @@ class Repo extends SupabaseObjectFunctions<Repo> {
   String studyId;
   GitProvider provider;
   @JsonKey(name: 'web_url')
-  String webUrl;
+  String? webUrl;
   @JsonKey(name: 'git_url')
-  String gitUrl;
+  String? gitUrl;
 
   Repo(this.projectId, this.userId, this.studyId, this.provider, this.webUrl, this.gitUrl);
 

core/lib/src/models/tables/study.dart

@@ -69,6 +69,8 @@ class Study extends SupabaseObjectFunctions<Study> {
   @JsonKey(name: 'registry_published')
   late bool registryPublished = false;
 
+  @JsonKey(includeToJson: false, includeFromJson: false)
+  List<StudyTag> studyTags = [];
   @JsonKey(includeToJson: false, includeFromJson: false)
   int participantCount = 0;
   @JsonKey(includeToJson: false, includeFromJson: false)
@@ -99,45 +101,66 @@ class Study extends SupabaseObjectFunctions<Study> {
 
   factory Study.fromJson(Map<String, dynamic> json) {
     final study = _$StudyFromJson(json);
+    final List? studyTags = json['study_tags'] as List?;
+    if (studyTags != null) {
+      study.studyTags = studyTags
+          .map(
+            (json) => StudyTag.fromTag(
+              studyId: study.id,
+              tag: Tag.fromJson(json as Map<String, dynamic>),
+            ),
+          )
+          .toList();
+    }
+
     final List? repo = json['repo'] as List?;
     if (repo != null && repo.isNotEmpty) {
       study.repo = Repo.fromJson((json['repo'] as List)[0] as Map<String, dynamic>);
     }
+
     final List? invites = json['study_invite'] as List?;
     if (invites != null) {
       study.invites = invites.map((json) => StudyInvite.fromJson(json as Map<String, dynamic>)).toList();
     }
+
     final List? participants = json['study_subject'] as List?;
     if (participants != null) {
       study.participants = participants.map((json) => StudySubject.fromJson(json as Map<String, dynamic>)).toList();
     }
+
     List? participantsProgress = json['study_progress'] as List?;
     participantsProgress = json['study_progress_export'] as List?;
     participantsProgress ??= json['subject_progress'] as List?;
     if (participantsProgress != null) {
       study.participantsProgress =
           participantsProgress.map((json) => SubjectProgress.fromJson(json as Map<String, dynamic>)).toList();
     }
+
     final int? participantCount = json['study_participant_count'] as int?;
     if (participantCount != null) {
       study.participantCount = participantCount;
     }
+
     final int? endedCount = json['study_ended_count'] as int?;
     if (endedCount != null) {
       study.endedCount = endedCount;
     }
+
     final int? activeSubjectCount = json['active_subject_count'] as int?;
     if (activeSubjectCount != null) {
       study.activeSubjectCount = activeSubjectCount;
     }
+
     final List? missedDays = json['study_missed_days'] as List?;
     if (missedDays != null) {
       study.missedDays = List<int>.from(json['study_missed_days'] as List);
     }
+
     final String? createdAt = json['created_at'] as String?;
     if (createdAt != null && createdAt.isNotEmpty) {
       study.createdAt = DateTime.parse(createdAt);
     }
+
     return study;
   }
 
@@ -234,6 +257,6 @@ class Study extends SupabaseObjectFunctions<Study> {
 
   @override
   String toString() {
-    return 'Study{id: $id, title: $title, description: $description, userId: $userId, participation: $participation, resultSharing: $resultSharing, contact: $contact, iconName: $iconName, published: $published, questionnaire: $questionnaire, eligibilityCriteria: $eligibilityCriteria, consent: $consent, interventions: $interventions, observations: $observations, schedule: $schedule, reportSpecification: $reportSpecification, results: $results, collaboratorEmails: $collaboratorEmails, registryPublished: $registryPublished, participantCount: $participantCount, endedCount: $endedCount, activeSubjectCount: $activeSubjectCount, missedDays: $missedDays, repo: $repo, invites: $invites, participants: $participants, participantsProgress: $participantsProgress, createdAt: $createdAt}';
+    return 'Study{id: $id, title: $title, description: $description, studyTags: $studyTags, userId: $userId, participation: $participation, resultSharing: $resultSharing, contact: $contact, iconName: $iconName, published: $published, questionnaire: $questionnaire, eligibilityCriteria: $eligibilityCriteria, consent: $consent, interventions: $interventions, observations: $observations, schedule: $schedule, reportSpecification: $reportSpecification, results: $results, collaboratorEmails: $collaboratorEmails, registryPublished: $registryPublished, participantCount: $participantCount, endedCount: $endedCount, activeSubjectCount: $activeSubjectCount, missedDays: $missedDays, repo: $repo, invites: $invites, participants: $participants, participantsProgress: $participantsProgress, createdAt: $createdAt}';
   }
 }

core/lib/src/models/tables/study_tag.dart

@@ -0,0 +1,70 @@
+import 'package:json_annotation/json_annotation.dart';
+import 'package:studyu_core/core.dart';
+
+part 'study_tag.g.dart';
+
+@JsonSerializable()
+class StudyTag extends SupabaseObjectFunctions<StudyTag> {
+  static const String tableName = 'study_tag';
+
+  @override
+  Map<String, dynamic> get primaryKeys => {'tag_id': tagId, 'study_id': studyId};
+
+  @JsonKey(name: 'study_id')
+  final String studyId;
+  @JsonKey(name: 'tag_id')
+  final String tagId;
+
+  @JsonKey(includeToJson: false, includeFromJson: false)
+  late Tag tag;
+
+  /*@JsonKey(includeToJson: false, includeFromJson: false)
+  late Study study;*/
+
+  StudyTag({
+    required this.studyId,
+    required this.tagId,
+  });
+
+  StudyTag.fromTag({
+    required this.tag,
+    required this.studyId,
+  }) : tagId = tag.id;
+
+  factory StudyTag.fromJson(Map<String, dynamic> json) {
+    final studyTag = _$StudyTagFromJson(json);
+
+    /*final Map<String, dynamic>? study = json['study'] as Map<String, dynamic>?;
+    if (study != null) {
+      studyTag.study = Study.fromJson(study);
+    }*/
+
+    final Map<String, dynamic>? tag = json['tag'] as Map<String, dynamic>?;
+    if (tag != null) {
+      studyTag.tag = Tag.fromJson(tag);
+    }
+
+    return studyTag;
+  }
+
+  String get name => tag.name;
+
+  String get id => tag.id;
+
+  @override
+  Map<String, dynamic> toJson() => _$StudyTagToJson(this);
+
+  @override
+  String toString() => toJson().toString();
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) || other is StudyTag && studyId == other.studyId && tag == other.tag;
+
+  @override
+  int get hashCode => id.hashCode ^ name.hashCode ^ studyId.hashCode ^ tag.hashCode;
+}
+
+extension StudyTagListToTagList on List<StudyTag> {
+  List<Tag> toTagList() => map((studyTag) => studyTag.tag).toList();
+}

core/lib/src/models/tables/tag.dart

@@ -0,0 +1,33 @@
+import 'package:json_annotation/json_annotation.dart';
+
+import 'package:studyu_core/core.dart';
+import 'package:studyu_core/src/util/supabase_object.dart';
+
+part 'tag.g.dart';
+
+@JsonSerializable()
+class Tag extends SupabaseObjectFunctions<Tag> {
+  static const String tableName = 'tag';
+
+  @override
+  Map<String, dynamic> get primaryKeys => {'id': id};
+
+  @JsonKey(name: 'id')
+  String id;
+  @JsonKey(name: 'name')
+  String name;
+
+  Tag({required this.id, required this.name});
+
+  factory Tag.fromJson(Map<String, dynamic> json) => _$TagFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$TagToJson(this);
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) || other is Tag && id == other.id && name == other.name;
+
+  @override
+  int get hashCode => id.hashCode ^ name.hashCode;
+}