From 9b1d0e807749697110858e4aa6540fdceda5de2e Mon Sep 17 00:00:00 2001 From: zara1504 <139195494+zara1504@users.noreply.github.com> Date: Sun, 23 Mar 2025 16:16:20 +1100 Subject: [PATCH 1/4] Add files via upload --- Migration-media-service-CR.md | 83 +++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 Migration-media-service-CR.md diff --git a/Migration-media-service-CR.md b/Migration-media-service-CR.md new file mode 100644 index 000000000..5fb50f25b --- /dev/null +++ b/Migration-media-service-CR.md @@ -0,0 +1,83 @@ +# OnTrack Component Review + +## Team Member Name +**Zara Danziger** +*Student ID: s223468285* + +--- + +## Component Name +**Media-services** + +--- + +## Files in this Component +- `Media-services.Coffee` + +--- + +## Component Purpose +The media services component is used for managing audio recording capabilities within the OnTrack application. It uses `AudioContext` and determines the most suitable MIME type for audio recordings based on the browser’s compatibility. + +--- + +## Screenshot +_No Screenshot Needed_ + +--- + +## Component Outcome and Interactions + +### Expected Outcomes +- Allows the application to start an `AudioContext` and determine the correct MIME type for the audio recording. +- It should work across different browsers by adapting the MIME type to the browser. +- It doesn’t handle actual media recordings but sets up the components needed for it. + +### Interactions + +#### Inputs: +- Uses `window.AudioContext` or `webkitAudioContext` if not already created. +- Uses `Navigator.userAgent` to determine MIME type compatibility. + +#### Outputs: +- Returns the detected MIME type for the audio recording. +- Initializes and provides an `AudioContext`. + +--- + +## Component Migration Plan + +### Migration Steps + +1. **Review Existing Component** + - Go over the current component. + - Identify functionalities. + +2. **Set Up Environment** + - Ensure the environment is properly set up and working within the correct branch (`9.x`). + +3. **Create Component** + - Develop a new component in **Angular 17 TS**. + +4. **Migrate and Downgrade Component** + - Follow the migration guide steps **3 and 4** to downgrade and migrate the component. + +5. **Testing** + - Test the application with the new component on multiple platforms (**Google Chrome, Safari**). + - Fix any issues before committing any changes. + +--- + +## Component Checklist + +- [ ] **Ability to initialize media context** + - Ensure an `AudioContext` is available for processing. + +- [ ] **Succeeds when data is valid** + - Returns a valid MIME type based on browser compatibility. + +- [ ] **Handles errors** + - Handles errors when no supported MIME type is found. + +- [ ] **Audio context is reusable** + - Prevents multiple `AudioContext` instances from being created. From 3445eb31cbc5ef1c83455a80fb16fa9243dcf692 Mon Sep 17 00:00:00 2001 From: zara1504 Date: Mon, 24 Mar 2025 09:08:07 +1100 Subject: [PATCH 2/4] fix: move file to correct folder --- .../OnTrack/UI Enhancement/Migration-media-service-CR.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename Migration-media-service-CR.md => docs/OnTrack/UI Enhancement/Migration-media-service-CR.md (100%) diff --git a/Migration-media-service-CR.md b/docs/OnTrack/UI Enhancement/Migration-media-service-CR.md similarity index 100% rename from Migration-media-service-CR.md rename to docs/OnTrack/UI Enhancement/Migration-media-service-CR.md From 0120d6e87393657202f4178d2f5fb96a86c89632 Mon Sep 17 00:00:00 2001 From: zara1504 Date: Thu, 3 Apr 2025 21:00:54 +1100 Subject: [PATCH 3/4] Add Analytic Service Component Review --- .../Migrate-analytic-service-CR | 63 +++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 docs/OnTrack/UI Enhancement/Component Reviews/Migrate-analytic-service-CR diff --git a/docs/OnTrack/UI Enhancement/Component Reviews/Migrate-analytic-service-CR b/docs/OnTrack/UI Enhancement/Component Reviews/Migrate-analytic-service-CR new file mode 100644 index 000000000..8f6ff465a --- /dev/null +++ b/docs/OnTrack/UI Enhancement/Component Reviews/Migrate-analytic-service-CR @@ -0,0 +1,63 @@ +# OnTrack Component Review + +## Team Member Name +**Zara Danziger** +*Student ID: s223468285* + +## Component Name +**Analytic Services** + +## Files in this Component +- `Analytic-services.Coffee` + +## Component Purpose +The `analytic-service` component is a way to track and log interactions the user has with the application. It collects data from users who have opened it. This service is used for logging different UI interactions and allows tracking of changes to different variables. + +## Screenshot +No Screenshot Needed + +## Component Outcome and Interactions + +### Expected Outcomes: +- Logs UI interactions with event categories, labels, and values. +- Automatically logs changes to scope variables. +- Stops invalid data from being logged. +- Ensures event tracking is only for users who consent. + +### Interactions: +#### Inputs: +- Gets event details including category, event name, label, and value. +- Watches variables for changes to start analytic events. + +#### Outputs: +- Shows an error if an invalid value is detected. +- Sends the analytics to `$analytics.eventTrack`. +- Ensures that the data is only collected from users who have opted in. + +## Component Migration Plan + +### Migration Steps: +1. **Review Existing Component** + - Go over the current component. + - Identify functionalities. + +2. **Set Up Environment** + - Ensure the environment is properly set up and working within the correct branch (9.x). + +3. **Create Component** + - Develop a new component in Angular17 TS. + +4. **Migrate and Downgrade Component** + - Follow the migration guide steps 3 and 4 to downgrade and migrate the component. + +5. **Testing** + - Test the application with the new component on multiple platforms (Google, Safari). + - Fix any issues before committing any changes. + +## Component Checklist +- [ ] Compliance with user consent + - Checks `newUserService.currentUser.optInToResearch` before logging any events. +- [ ] Logs analytic events. +- [ ] Handles data correctly. +- [ ] Handles errors. + - Stops tracking if the component is missing. \ No newline at end of file From dc86dc9e44cc51357916b02b689cb4792a90d95a Mon Sep 17 00:00:00 2001 From: zara1504 <139195494+zara1504@users.noreply.github.com> Date: Thu, 3 Apr 2025 21:04:20 +1100 Subject: [PATCH 4/4] Delete docs/OnTrack/UI Enhancement/Migration-media-service-CR.md Accidentally added my previous component review to this. --- .../Migration-media-service-CR.md | 83 ------------------- 1 file changed, 83 deletions(-) delete mode 100644 docs/OnTrack/UI Enhancement/Migration-media-service-CR.md diff --git a/docs/OnTrack/UI Enhancement/Migration-media-service-CR.md b/docs/OnTrack/UI Enhancement/Migration-media-service-CR.md deleted file mode 100644 index 5fb50f25b..000000000 --- a/docs/OnTrack/UI Enhancement/Migration-media-service-CR.md +++ /dev/null @@ -1,83 +0,0 @@ -# OnTrack Component Review - -## Team Member Name -**Zara Danziger** -*Student ID: s223468285* - ---- - -## Component Name -**Media-services** - ---- - -## Files in this Component -- `Media-services.Coffee` - ---- - -## Component Purpose -The media services component is used for managing audio recording capabilities within the OnTrack application. It uses `AudioContext` and determines the most suitable MIME type for audio recordings based on the browser’s compatibility. - ---- - -## Screenshot -_No Screenshot Needed_ - ---- - -## Component Outcome and Interactions - -### Expected Outcomes -- Allows the application to start an `AudioContext` and determine the correct MIME type for the audio recording. -- It should work across different browsers by adapting the MIME type to the browser. -- It doesn’t handle actual media recordings but sets up the components needed for it. - -### Interactions - -#### Inputs: -- Uses `window.AudioContext` or `webkitAudioContext` if not already created. -- Uses `Navigator.userAgent` to determine MIME type compatibility. - -#### Outputs: -- Returns the detected MIME type for the audio recording. -- Initializes and provides an `AudioContext`. - ---- - -## Component Migration Plan - -### Migration Steps - -1. **Review Existing Component** - - Go over the current component. - - Identify functionalities. - -2. **Set Up Environment** - - Ensure the environment is properly set up and working within the correct branch (`9.x`). - -3. **Create Component** - - Develop a new component in **Angular 17 TS**. - -4. **Migrate and Downgrade Component** - - Follow the migration guide steps **3 and 4** to downgrade and migrate the component. - -5. **Testing** - - Test the application with the new component on multiple platforms (**Google Chrome, Safari**). - - Fix any issues before committing any changes. - ---- - -## Component Checklist - -- [ ] **Ability to initialize media context** - - Ensure an `AudioContext` is available for processing. - -- [ ] **Succeeds when data is valid** - - Returns a valid MIME type based on browser compatibility. - -- [ ] **Handles errors** - - Handles errors when no supported MIME type is found. - -- [ ] **Audio context is reusable** - - Prevents multiple `AudioContext` instances from being created.