@clickview/ship-it 0.0.18 → 0.0.20-dev.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (138) hide show
  1. package/README.md +48 -48
  2. package/config.json +10 -10
  3. package/lib/config.json +11 -11
  4. package/lib/src/api-clients/git-lab/GitLabApiClient.js +404 -404
  5. package/lib/src/api-clients/git-lab/GitLabMapper.js +81 -81
  6. package/lib/src/api-clients/index.js +18 -18
  7. package/lib/src/api-clients/team-city/TeamCityApiClient.js +85 -85
  8. package/lib/src/commands/BumpPackagesCommand.js +84 -84
  9. package/lib/src/commands/CreateBranchCommand.js +100 -100
  10. package/lib/src/commands/CreateMergeRequestCommand.js +107 -107
  11. package/lib/src/commands/CreateReleaseNotesCommand.js +84 -84
  12. package/lib/src/commands/CreateTestingNotesCommand.js +84 -84
  13. package/lib/src/commands/InstallPackagesCommand.js +76 -76
  14. package/lib/src/commands/ListProjectsCommand.js +76 -76
  15. package/lib/src/commands/ReleaseCommand.js +129 -129
  16. package/lib/src/commands/StartConsumingProjectBuildsCommand.js +76 -76
  17. package/lib/src/commands/StatusCommand.js +88 -88
  18. package/lib/src/commands/TagMasterCommand.js +76 -76
  19. package/lib/src/commands/ValidateMergeRequestCommand.js +76 -76
  20. package/lib/src/commands/VersionCommand.js +76 -76
  21. package/lib/src/commands/index.js +29 -29
  22. package/lib/src/constants/CommandTypeMapping.js +19 -19
  23. package/lib/src/constants/GitLabMemberIds.js +6 -6
  24. package/lib/src/constants/MonorepoPackageJsonFiles.js +16 -15
  25. package/lib/src/constants/ProjectNames.js +62 -61
  26. package/lib/src/constants/TeamCityBuildIDs.js +15 -15
  27. package/lib/src/constants/index.js +19 -19
  28. package/lib/src/errors/ShipItError.js +32 -32
  29. package/lib/src/errors/index.js +17 -17
  30. package/lib/src/index.js +18 -18
  31. package/lib/src/interfaces/Config.js +2 -2
  32. package/lib/src/interfaces/MergeRequestState.js +2 -2
  33. package/lib/src/interfaces/ProjectNames.js +2 -2
  34. package/lib/src/interfaces/ShipItCommand.js +2 -2
  35. package/lib/src/interfaces/ShipItTask.js +2 -2
  36. package/lib/src/interfaces/VersionType.js +2 -2
  37. package/lib/src/interfaces/command-cli-options/MilestoneCommandCliOptions.js +2 -2
  38. package/lib/src/interfaces/command-cli-options/ReleaseCommandCliOptions.js +2 -2
  39. package/lib/src/interfaces/command-cli-options/index.js +18 -18
  40. package/lib/src/interfaces/command-options/BaseCommandOptions.js +2 -2
  41. package/lib/src/interfaces/command-options/BumpPackagesCommandOptions.js +2 -2
  42. package/lib/src/interfaces/command-options/DockerMilestoneCommandOptions.js +2 -2
  43. package/lib/src/interfaces/command-options/MilestoneCommandOptions.js +2 -2
  44. package/lib/src/interfaces/command-options/ReleaseCommandOptions.js +2 -2
  45. package/lib/src/interfaces/command-options/ValidateMRCommandOptions.js +2 -2
  46. package/lib/src/interfaces/command-options/index.js +21 -21
  47. package/lib/src/interfaces/index.js +26 -26
  48. package/lib/src/interfaces/models/Branch.js +2 -2
  49. package/lib/src/interfaces/models/Commit.js +2 -2
  50. package/lib/src/interfaces/models/CommitFile.js +2 -2
  51. package/lib/src/interfaces/models/File.js +2 -2
  52. package/lib/src/interfaces/models/Label.js +2 -2
  53. package/lib/src/interfaces/models/MergeRequest.js +2 -2
  54. package/lib/src/interfaces/models/Milestone.js +2 -2
  55. package/lib/src/interfaces/models/Project.js +2 -2
  56. package/lib/src/interfaces/models/ProjectConfig.js +9 -9
  57. package/lib/src/interfaces/models/Release.js +2 -2
  58. package/lib/src/interfaces/models/Tag.js +2 -2
  59. package/lib/src/interfaces/models/index.js +26 -26
  60. package/lib/src/interfaces/view-models/MilestoneProject.js +2 -2
  61. package/lib/src/interfaces/view-models/index.js +17 -17
  62. package/lib/src/inversify.config.js +67 -67
  63. package/lib/src/services/GitLabService.js +498 -498
  64. package/lib/src/services/TeamCityService.js +34 -34
  65. package/lib/src/services/index.js +18 -18
  66. package/lib/src/startup/AddMilestoneCommand.js +95 -95
  67. package/lib/src/startup/GetAction.js +68 -68
  68. package/lib/src/startup/SetupCommands.js +128 -127
  69. package/lib/src/tasks/BumpPackagesTask.js +229 -229
  70. package/lib/src/tasks/BumpVersionTxtTask.js +110 -110
  71. package/lib/src/tasks/CommitPackageVersionsTask.js +116 -116
  72. package/lib/src/tasks/CreateBranchTask.js +104 -104
  73. package/lib/src/tasks/CreateMergeRequestTask.js +118 -118
  74. package/lib/src/tasks/CreateReleaseNotesTask.js +122 -122
  75. package/lib/src/tasks/CreateTestingNotesTask.js +135 -135
  76. package/lib/src/tasks/InstallPackagesTask.js +399 -351
  77. package/lib/src/tasks/ListProjectsTask.js +87 -87
  78. package/lib/src/tasks/StartConsumingProjectBuildsTask.js +149 -149
  79. package/lib/src/tasks/StartMonorepoBuildTask.js +95 -95
  80. package/lib/src/tasks/TagMasterTask.js +121 -121
  81. package/lib/src/tasks/ValidateCommitsTask.js +119 -119
  82. package/lib/src/tasks/ValidateDescriptionsTask.js +151 -151
  83. package/lib/src/tasks/ValidateMergeRequestTask.js +115 -115
  84. package/lib/src/tasks/ValidateTask.js +240 -237
  85. package/lib/src/tasks/VersionTask.js +98 -98
  86. package/lib/src/tasks/index.js +33 -33
  87. package/lib/src/types.js +49 -49
  88. package/lib/src/utils/BranchNames.js +11 -11
  89. package/lib/src/utils/Commits.js +55 -55
  90. package/lib/src/utils/Csv.js +54 -54
  91. package/lib/src/utils/Descriptions.js +237 -237
  92. package/lib/src/utils/GroupIds.js +6 -6
  93. package/lib/src/utils/Logger.js +62 -62
  94. package/lib/src/utils/ProjectIds.js +47 -47
  95. package/lib/src/utils/Versions.js +20 -20
  96. package/lib/src/utils/index.js +22 -22
  97. package/package.json +47 -47
  98. package/dist/A2/A2 Testing Notes.csv +0 -518
  99. package/dist/A2/Batch.Api.md +0 -37
  100. package/dist/A2/ClickView.Curator.md +0 -17
  101. package/dist/A2/Clients.md +0 -23
  102. package/dist/A2/Discover.Api.md +0 -14
  103. package/dist/A2/FileGenerator.md +0 -8
  104. package/dist/A2/Krakend.md +0 -25
  105. package/dist/A2/Library.Api.md +0 -13
  106. package/dist/A2/Lite.md +0 -27
  107. package/dist/A2/Master.Auth.md +0 -52
  108. package/dist/A2/Objects.Api.md +0 -8
  109. package/dist/A2/Permissions.Api.md +0 -12
  110. package/dist/A2/Release Notes.md +0 -479
  111. package/dist/A2/Search.Api.md +0 -12
  112. package/dist/A2/Subjects.API.md +0 -22
  113. package/dist/A2/Users.Api.md +0 -63
  114. package/dist/A2/clickview.md +0 -83
  115. package/dist/A2/index.app.md +0 -15
  116. package/dist/Z2/Analytics Web.md +0 -7
  117. package/dist/Z2/Batch.Api.md +0 -13
  118. package/dist/Z2/ClickView Online.md +0 -19
  119. package/dist/Z2/ClickView.Cron.md +0 -8
  120. package/dist/Z2/ClickView.Curator.md +0 -39
  121. package/dist/Z2/Clients.md +0 -31
  122. package/dist/Z2/Discover.Api.md +0 -12
  123. package/dist/Z2/Domain.Api.md +0 -31
  124. package/dist/Z2/Image.Api.md +0 -12
  125. package/dist/Z2/Krakend.md +0 -33
  126. package/dist/Z2/LTI.md +0 -8
  127. package/dist/Z2/Launch.Web.md +0 -9
  128. package/dist/Z2/Library Editor.md +0 -7
  129. package/dist/Z2/Library.Api.md +0 -13
  130. package/dist/Z2/Lite.md +0 -32
  131. package/dist/Z2/Master.Auth.md +0 -16
  132. package/dist/Z2/Objects.Api.md +0 -9
  133. package/dist/Z2/Permissions.Api.md +0 -0
  134. package/dist/Z2/Prospect.Api.md +0 -17
  135. package/dist/Z2/RealtimeSalesforceSync.md +0 -19
  136. package/dist/Z2/Release Notes.md +0 -549
  137. package/dist/Z2/Users.Api.md +0 -13
  138. package/dist/Z2/clickview.md +0 -135
@@ -1,549 +0,0 @@
1
-
2
- # clickview
3
-
4
- ## Dependencies
5
- - https://gitlab.cvinternal.net/clickview/front-end/clickview/-/merge_requests/3007
6
- - https://gitlab.cvinternal.net/clickview/front-end/ClickView.Curator/-/merge_requests/1068
7
- - https://gitlab.cvinternal.net/clickview/front-end/clickview/-/merge_requests/2944
8
- - https://gitlab.cvinternal.net/clickview/front-end/clickview/-/merge_requests/2941
9
-
10
- ## Curator
11
-
12
- ### Customer changes
13
- - Fixed an issue where adding hidden, pedagogy and skill tags were restricted by max keyword tags. Fixes INBOX-4554.
14
- - Fixed issue where we could add max allowed keyword tags number + 1.
15
- - Fixed a bug where a hero video or featured video widget could be in the TOC when it had no name. Fixes CC-476
16
- - (dev only) Added navigation to the assembly line to switch between ingestion, curation, and resourcing tabs. Implements CC-468
17
- - (dev only) Added a search bar to the assembly line. Implements CC-468
18
- - Fixed a bug where a user's display name would never show up in Curator in the "edit details" form. Fixes INBOX-4480
19
- - Added support for a new "Enhanced slider small" video widget template. Implements LTE-1820
20
-
21
- ### Code changes
22
- - Updated `canAddNormalTag` method `TagHelper` to check for less than instead of less than or equal to.
23
- - In `EditVideoTagsView` the `createAndAssociateTag` method now check the tag type and if the error is relevant to the type.
24
- - Updated the route for the trial management page in curator.
25
- - Setup and exported an `AssemblyLineApplication`.
26
-
27
- ## Lite
28
-
29
- ### Code changes
30
- - Fixed a bug where if you search for something, then resize the browser window to make the search bar collapse into the icon, the search event the logged when you first searched would log again. Fixes INBOX-4196
31
- - Update 'container-compact' to match the design. Implements INBOX-4528
32
- - Added new hook `useCountryPlaceholder` to get / generate a placeholder for any country.
33
- - Updated `LocalityHelper` with methods to get default placeholders for supported country.
34
- - Updated `SearchLocalityInput` to use the `useCountryPlaceholder`.
35
- - Added `event_topic` property to braze custom event submission data. Implements LTE-1832.
36
- - Removed `user_type1 braze user attribute. Implements LTE-1830.
37
- - Update braze custom even type name to `product_trial_requested` as requested by Andrew.
38
- - Added analytics events to be consistent with [Sign up flow diagram](https://www.figma.com/file/p7yMOWyPyftDmc21kb2Lh6/Sign-up-flow?node-id=0-1&t=ItRGomT3BCH9i1yi-0)
39
- - Added `useAutoCompleteService` hook to load google api and get an instance of the service.
40
- - Fixed issue when creating prospects from Cant find school step did not have `city` or `province` data.
41
- - Updated `registerStore` to load permissions in at startup once we have access to the `currentUser`
42
- - Fixes INBOX-4516
43
- - Add calendar utils to convert date to table of week date. Implements LTE-1813
44
- - Add Calendar component. Implements LTE-1788
45
- - Add jump to the next/previous month toolbar function. Implements LTE-1814
46
- - Limits "jump to" month range for the calendar. LTE-1828
47
- - Add Special Event Calendar application. Implements LTE-1812
48
- - Add Calendar button to DiscoverHeader
49
- - Add new setting to feature switch Implements LTE-1822
50
-
51
- ### Customer changes
52
- - The text in the audience filter buttons on topic pages can no longer be highlighted. Fixes INBOX-4277
53
- - Fixed an issue where topics wouldn't show a proper 404 page if the topic couldn't be found. Fixes INBOX-4287
54
- - Now in Lite, the student feed page has a wider width to match the topic page width.
55
- - Fixed an issue where if you filter a curated topic page by an audience so that all videos/playlists/series beneath a blurb heading are filtered out, but there is still a topic widget underneath that blurb heading, the heading will be filtered out. Fixes INBOX-4476
56
- - As an anon user, you no longer need to click on the CTA of the "welcome" popup to close the popup, if the region only has 1 presentation. Fixes INBOX-4510
57
- - Fixed a bug where using the presentation switcher on any settings page would take you to the settings page instead of the dashboard.
58
- - Remove the ability for students to create clips. Implements INBOX-4562. The rational behind this decision is that as it currently stands, students cannot share so the clip functionality is somewhat meaningless. We intend to bring this feature back in a future release when we revisit student clips, interactives and sharing.
59
- - Users who enter an existing email into the sign up form will now be taken to the login page with their email prefilled. This will also mean if the email domain is linked to SSO, they will immediately be prompted with the IDP picker (School picker).
60
- - Users who select an existing school will now be prompted to sign in using SSO, this will take them to the login page with both their email and their customer id prefilled. In Z3 we will be updating this to actually check if the school in question has SSO, as to only show the log in button when the school is using SSO.
61
- - International prospects signing up will not be defaulted to 'US' locale anymore. Implements LTE-1819.
62
- - The Locality search placeholder displays a random city from the prospects country.
63
- - If the geocoder fails when clicking 'use my location' in sign up, we now display a relevant error. Implements LTE-1818.
64
- - Fixed an issue when creating prospects from 'Cant find school step' which did not send 'city' or 'province' data. Fixes LTE-1829.
65
- - (dev only) In the Lite, staff can now see a monthly calendar (range from the previous 6 months to the next 12 months) on the `/calendar` page.
66
- - Students can no longer search for clips and interactives. Fixes INBOX-4521
67
- - Fixed an issue where the search page would not scroll back to the top if you entered a new search term. Fixes INBOX-4526.
68
- - Added a nicer hover state for the clip and interactive badges. Implements LTE-1796
69
- - Updated small video widget templates to display the same total columns and thumbnail sizes as "large" versions on any screen size below 1200px
70
- - All horizontal sliders can now be scrolled through freely without any snapping (except for student feed). Implements LTE-1797
71
- - Fixed a bug in the student feed on playlists and series, where if you're on a touch screen and are swiping through the videos, the indicator dots underneath don't update.
72
- - On mobile and tablet devices, browsings through the horizontal topics slider is now much easier. The forwards and backwards buttons are no longer shown and the user can simply scroll through the list like in the ClickView apps. Fixes INBOX-4451
73
-
74
- ## Player
75
-
76
- ### Customer changes
77
- - The favourite button styles have been updated the match the changes made to the favourite button for the new discover and topics dashboards.
78
-
79
- ## Shared
80
-
81
- ### Code changes
82
- - Added a new `Count` badge type
83
- - Updated `PillTabSelector` to optionally accept a count for each tab
84
- - Updated `ScopedSearchBar` to optionally accept analytics props
85
- - Update padding & margin in video guidance in the hover card. Fix INBOX-4487
86
- - Added a new `useBreakpoints` hook, which can be used to know which breakpoint the page is currently on. Partially implements INBOX-4474
87
- - Deprecated `useGetMediaQueryString` in favour of `useBreakpoints`
88
- - Updated all code under `/libs/shared/components/widgets/*` to use `useBreakpoints` and to use Bootstrap's SCSS breakpoint mixin instead of the old media query mixin. Partially implements INBOX-4474
89
-
90
- ## Styles
91
-
92
- ### Code changes
93
- - Added a new `count-badge` class
94
-
95
- ## Testing
96
- - In NP, open your network tab, and search for something. When you unfocus the search bar, a `cv_product_search` event should get logged. Now, shrink your browser window down to a screen size small enough for the search bar to be replaced with a search icon. In your network tab, you should not see a second event logged for `cv_product_search`. If you follow these replication steps in production, you will see that it logs every time you resize the window to make the search icon appear or disappear.
97
- - You should not be able to highlight the text in audience filter buttons on topic pages in NP.
98
- - In NP, go to the topics URL and enter a fake ID into the URL. When you go to that URL, you should see a "Topic not found" error page
99
- - Open [this dashboard](https://www.staging.clickview.net/topics/5Rezqqw/cells?dashboardId=164552081066225664&preview=true&skipPrompt=true) and filter by "year 7". The second heading should get filtered out along with the hero video underneath it, but the topic widget should remain in place
100
- - In Curator, go to the (new) manage video page, we should:
101
- - Not be able to add more than 10 keyword tags.
102
- - Be able to add any amount of hidden tags.
103
- - Be able to select any amount of pedagogy and skill tags.
104
- - In NP, go to latest releases, click "Update your preferences", then use the presentation switcher to switch your presentation. You should end up on the dashboard, not the settings page.
105
- - In NP as a student, ensure you cannot create a clip from the play page, video actions in list views, and from the player.
106
- - In NP, sign up using an existing email, note that when taken to auth, your email is prefilled.
107
- - In NP, sign up with a non existing email and select a school that has SSO, note when taken to auth, you are taken to the IDP selector with only one option.
108
- - In Lite, Use a vpn to sign up from any country other than (`AU`, `UK`, `NZ` and `US`)
109
- - The Find school step's locality search should be scoped to that country.
110
- - The locality input placeholder should include a randomly generate city from that country in format `E.g. {randomCity}`
111
- - If we click 'use my current location' and block the request when it popups, we should display an relevant error.
112
- - In 'Cant find school step' we should be able to create a new prospect school and the request object should have 'city' and 'province' data.
113
- - We should be logging analytics events where ever we have 'logAction' in this [Sign up flow diagram](https://www.figma.com/file/p7yMOWyPyftDmc21kb2Lh6/Sign-up-flow?node-id=0-1&t=ItRGomT3BCH9i1yi-0)
114
- - Create a hero media widget -> enter a heading -> check the TOC checkbox -> remove the heading. The TOC checkbox should automatically be unchecked.
115
- - (dev only) In curator's assembly line, you should be able to browse between ingestion, curation, and resourcing tabs.
116
- - In NP:
117
- - As both an authenticated and public user:
118
- - There should no longer be a request to fetch permissions via API. It will instead be loaded from bootstrapped data.
119
- - In lite, staff whose `Has special event calendar` domain option set to be true should see a correct calendar on the `/calendar` page. The calendar should start from Monday. The left/ right arrow button in the top right of the calendar should navigate the user to the next/previous month accordingly. The `Today` button should navigate to the current month. User can only go to previous 6 months and next 6 months.
120
- - Students in NP should no longer be able to search for clips and interactives.
121
- - Students in NP should no longer be able to filter by "clips" and "interactives" in the "Types" filter
122
- - Anon users in NP should still be able to search for clips and interactives
123
- - Staff users in NP should still be able to search for clips and interactives
124
- - In NP, search for a term, scroll down to the bottom of the page, then update the search to a new term. The page should scroll back to the top.
125
- - When editing a user, their display name should be autofilled in the form.
126
- - Hover on the clip and interactive badges in NP. They should smoothly expand to reveal the text "Clip" or "Interactive"
127
- - You should now be able to create a "New small slider" video widget in Curation Studio.
128
- - [This dashboard](https://staging.clickviewcurator.com/manage/dashboards/163428263073574912/edit), which has 4 video widgets with 4 different slider templates, should:
129
- - Display the accurate partial loading at every screen size
130
- - Should be able to browse all the way through to the end of the widget using the "next" button at every screen size
131
- - At screen size above 1200px, the "small" templates should display 4 videos at a time, while the "large" templates should display 3 videos at a time (and the partial loading should reflect this)
132
- - At screen sizes below 1200px, the "small" and "large" templates should all display the same number of videos
133
- - The recent activities widget on the student feed should be browsable to the end of the widget at all screen sizes
134
- - In lite, set the domain option of `Has Special Event Calendar` to true for a customer, log in as staff from that customer, and there will be a new `Calendar` button in the discover header. Click on it should navigate you to `/special-event-calendar` page.
135
- - Stress test all sliders on mobile (touch screen swiping). Everything should look and feel good
136
- - On mobile, test out the touchscreen slider behavior for topic slider widgets. The behavior should be smooth horizontal scrolling and not feel buggy or janky. The widget should also no longer display "next" and "previous" buttons, as the only way to browse now is by scrolling.
137
- - On desktop, test out the topic slider widgets in both NP and Online. They should behave like normal.
138
-
139
-
140
- # ClickView.Curator
141
-
142
- ## Dependencies
143
- - https://gitlab.cvinternal.net/clickview/front-end/clickview/-/merge_requests/3007
144
-
145
-
146
- ## Customer changes
147
- - Now in Curator, Sales support or support users can see 'Share to Microsoft Teams' and 'Share to Google Classroom' options.
148
-
149
- - (dev only) added a new "Assembly Line" route to the Content subnav
150
-
151
- - CS and PS will now have access to the updated trial management tab, this tab will only show if the customer is on the NP. Implements LTE-1810.
152
-
153
-
154
- ## Code changes
155
- - Show 'Share to Microsoft Teams' and 'Share to Google Classroom' options to support and sales support users.
156
-
157
- - Upgrade the following projects to the new csproj format
158
- - ApiClients
159
- - Contracts
160
- - Models
161
- - MongoRepository
162
- - Services
163
- - Utils
164
- - Added `nuget.config` with ClickView nuget server defined
165
- - Bump `System.Threading.Tasks.Extensions` from `4.5.1` to `4.5.2`
166
-
167
-
168
- ## Testing
169
- - Now in Curator, log in as PS, CS, or advisor. In the domain options list, you can see the 'Share to Microsoft Teams' and 'Share to Google Classroom' options.
170
-
171
- - Devs should be able to see and access the "Assembly Line" tab in the content subnav. Content and curator roles should not see this or be able to access this.
172
-
173
- - In curator, with a PS and a CS account go to the trial tab for a customer on the new product.
174
- - Put the school on an access policy
175
- - Ensure that NP shows the banner
176
- - Change the date of the policy, ensure that the date changes in product
177
- - Set the date of the policy to the next day, come back the next day and ensure that the customer has been disabled
178
-
179
-
180
-
181
-
182
- # Lite
183
-
184
- ## Before release
185
- * [ ] Add prerender config to octo
186
-
187
-
188
- ## Dependencies
189
- * https://gitlab.cvinternal.net/clickview/front-end/clickview/-/tree/lite/supress-welcome-popup
190
-
191
-
192
- ## Customer changes
193
- - Added a passthrough to hit the prospect lookups endpoint in prospect api.
194
-
195
-
196
- ## Code changes
197
- * Add `isBot=true` query parameter to the prerender request, so that the frontend can full load the page for rendering
198
-
199
- - Going to `/login?email=<youremail>` should take you to auth with your username/email filled out
200
-
201
- * Add a prerender middleware to allow javascript pages to be prerendered by prerender.io if the request is coming from searching engine bot
202
-
203
-
204
- ## Testing
205
- * n/a
206
-
207
-
208
- - While not signed into NP ho to `https://staging.clickview.net/login?email=<youremail>`. You should land in auth on the second step of logging in.
209
-
210
- * To test locally, we need to run the prerender server locally first as per https://github.com/prerender/prerender#running-locally
211
- * Hitting url https://localhost:5001/au?_escaped_fragment_= in the browser, a static html webpage should be rendered
212
- ![image](/uploads/ecd05da9892061cb08ef1e80bfaa8a65/image.png)
213
- * Execute https://localhost:5001/au in fiddler with `UserAgent=ClickViewBot`, it should return static html data without any `script` tag
214
-
215
-
216
-
217
- # Krakend
218
-
219
- ## Before release
220
- * [ ] Off-the-shelf KrakenD 2.2.1 docker needs to be deployed to production
221
-
222
-
223
- ## Dependencies
224
- * This setting only works with the latest official KrakenD build 2.2.1
225
-
226
- * This setting only works with the latest official KrakenD build
227
-
228
-
229
- ## Customer changes
230
- * Obfuscate `X-Krakend` version number. Related to CORE-794
231
-
232
-
233
- ## Code changes
234
- * Add `"cache": true` in `auth/validator` section in `krakend.json`
235
-
236
- * Add `"hide_version_header": true` to `service.json`
237
-
238
- * Update `krakend.json` to comply with v3 KrakenD configuration file
239
- * Remove lua script that is used for gorilla mux router and no longer needed for the off-the-shelf KrakenD 2.2.1 which uses gin router
240
- * Update `service.json` to comply with v3 Krakend configuration file
241
- * Close INBOX-4421
242
-
243
-
244
- ## Testing
245
- * All endpoints should work as usual
246
-
247
- * Check the response header of any gateway api request, `Version undefined` should be shown in the header `X-Krakend`![image](/uploads/6cd4d7e4e78eaa035f670b3fe82fa7da/image.png)
248
-
249
- * All endpoints should still work
250
-
251
-
252
-
253
- # Clients
254
-
255
- ## Dependencies
256
- * https://gitlab.cvinternal.net/clickview/back-end/library.api/-/merge_requests/101
257
-
258
- ## ClickView.Clients.Braze
259
-
260
- ### Code changes
261
- - Fix an issue where the user track error responses were the wrong type
262
- - Make all the user track method arguments optional
263
- - Add tests
264
- - Fix an issue where the user track error responses were the wrong type
265
- - Make all the user track method arguments optional
266
- - Add tests
267
-
268
- ## ClickView.Clients.Email.v2
269
-
270
- ### Code changes
271
- - Added test to ensure emails with attachments can be sent
272
- - Change `Attachment.Bytes` from `IEnumerable<byte>` to `byte[]` to avoid sending either base64 strings or lists of bytes to email api
273
-
274
- ## ClickView.Clients.Library
275
-
276
- ### Customer changes
277
- * Address the issue where directly added library requests are not shown as past requests. Close INBOX-4039
278
-
279
- ### Code changes
280
- * Add `AutoApproved` to `LibraryRequestStatus` enum
281
-
282
- ## Testing
283
- * n/a
284
- - Tests pass
285
-
286
-
287
- # Objects.Api
288
-
289
- ## Code changes
290
- * Added support for assoc nodes in virtual assocs
291
-
292
-
293
- ## Testing
294
- * You should be able to send assoc params on certain virtual assoc. Right now, the only virtual assoc that accepts the assoc nodes is `_parentVideo`. It currently supports `rating`, `thumbnail`, `subtitles`, `resources`, and `subjectpresentationaudices` assoc nodes.
295
- * Sending assoc nodes that isn't supported should result in 400 error. For example, sending `_parentVideo[bananas]`
296
-
297
-
298
-
299
- # Prospect.Api
300
-
301
- ## Before release
302
- - Run `ClickView.ProspectApi.Data.MySql.DbUp`
303
-
304
-
305
- ## Code changes
306
- - Create endpoint `GET v1/domains?status={status}` for getting domains by status
307
- - Support `status` query parameter for endpoint `GET v1/prospects/{prospectId}/domains` for getting domains by prospect and status
308
- - Add `Description` property to domains
309
- - Update `Status` property on domains to support the values:
310
- - Verified
311
- - Unverified
312
- - Denied
313
-
314
-
315
- ## Testing
316
-
317
-
318
-
319
- # Batch.Api
320
-
321
- ## Before release
322
- * [ ] Update `Clients.*` nuget packages to a stable version `2.11.0`
323
-
324
-
325
- ## Code changes
326
- * Remove `ToList()` for email attachments
327
- * Update all nuget packages to the latest
328
-
329
-
330
- ## Testing
331
- * In NP, go to Settings->Student manager/Staff manager->Select some users->Select a bulk action, and then run through the bulk action wizard. An email with a bulk action report in the attachment should be sent to you once the bulk action is completed.
332
-
333
-
334
-
335
- # Users.Api
336
-
337
- ## Before release
338
- * [ ] Update `Clients.*` nuget packages to the stable version `2.11.0`
339
-
340
-
341
- ## Code changes
342
- * Remove `ToList()` for email attachments
343
- * Update all nuget packages to the latest
344
-
345
-
346
- ## Testing
347
- * In NP, go to Settings->Student manager/Staff manager->Add new students/Add new staffs->Upload a spreadsheet, and then create user from the spreadsheet. An email with created users in the attachment should be sent to you.
348
-
349
-
350
-
351
- # Library.Api
352
-
353
- ## Customer changes
354
- * Add the directly added library requests to the past requests list in LE. Close INBOX-4039
355
-
356
-
357
- ## Code changes
358
- * Add `AutoApproved` to `LibraryRquestStatus` enum to keep track of the library requests when adding videos directly to library by admin or authorized staff
359
- * Add the library request to db in `ByPassLibraryRequestAsync()`
360
-
361
-
362
- ## Testing
363
- * Login NP as admin and add a Workspace video to the school's library, the video should be available in library straightaway as usual and a record should be shown in `Past requests` tab in LE with `Auto-approved` status (this requires changes to be made in LE to fetch library requests with `AutoApproved` status. Otherwise, this needs to be checked in `library_requests` table in `cv_library` db and make sure `Status` column has a value of `4`)
364
-
365
-
366
-
367
- # ClickView.Cron
368
-
369
- ## Code changes
370
- * Added newtonsoft json. Looks like some endpoints breaks without it. Fixes INBOX-4540
371
-
372
-
373
- ## Testing
374
- * When sending notifications through curator, make sure it works
375
-
376
-
377
-
378
- # LTI
379
-
380
- ## Code changes
381
- - Updated to LTI 1.3 Deep linking to work with Schoolbox. Partially addresses INBOX-4163
382
-
383
-
384
- ## Testing
385
- - Using the test credentials on `https://clickview.atlassian.net/browse/INBOX-4163`, set up a staging LTI 1.3 setup with schoolbox, add an assignment, and after selected the assignment, ensure that schoolbox does not show a popup saying that the selected item is not an assessment.
386
-
387
-
388
-
389
- # Domain.Api
390
-
391
- ## Before release
392
- - [ ] Execute script `next.sql`
393
-
394
-
395
- ## Dependencies
396
- - [ ] Execute it after the release of https://gitlab.cvinternal.net/clickview/back-end/Image.Api/-/merge_requests/106
397
-
398
-
399
- ## Customer changes
400
- - Video at a glance images should load as `https`
401
-
402
- * Fixed an issue where subtitle does not show when adding a TV guide or ad-free video to workspace for non-curator user. Close INBOX-4482
403
-
404
-
405
- ## Code changes
406
- * Updated old domain logic to return archived video's interactive. Fixes INBOX-4425
407
-
408
- - SQL script to update `http` URLs to `https`. FIXES INBOX-4380
409
-
410
- * Physically duplicate the subtitle by using file api and assign it `write` permission for the customer of workspace's owner
411
-
412
-
413
- ## Testing
414
- * On online, create an interactive on an archived video and go to the video play page. In the interactive tab, the interactive should show up
415
-
416
- - In a video page with `Video at a glance...`, images should be requested as `https`
417
- - When uploading images to themes in `Curator > Content > Themes`, Image Api should return `location` as `https`
418
-
419
- * Login Online as non-curator account and go to TV and add any ad-free video to the workspace, the caption icon in the player should be enabled
420
-
421
-
422
-
423
- # Image.Api
424
-
425
- ## Customer changes
426
- - When uploading images, urls should be `https`
427
-
428
-
429
- ## Code changes
430
- - Added X-Forwarded header support. Partially fixes INBOX-4380
431
-
432
-
433
- ## Testing
434
- - Uploading images for Themes in curator, URLs should be `https`
435
-
436
-
437
-
438
- # Discover.Api
439
-
440
- ## Before release
441
- - [ ] Execute script `next.sql`
442
-
443
-
444
- ## Code changes
445
- - Added new template `popout_thumbnail_sliding_list_small`. Implements CORE-1082
446
-
447
-
448
- ## Testing
449
- - In Discover API, new template `popout_thumbnail_sliding_list_small` should be allowed to be used with widget types `curated_media`, `playlist_media` and `classification_media`
450
-
451
-
452
-
453
- # Master.Auth
454
-
455
- ## Code changes
456
- - Use `cross-env` to make js builds cross platform
457
-
458
- - Small cleanups after !351
459
- - Replace `GetMembers` with a `GetAllMembersAsync` so you dont need to deal with `PagedCollectionResult`
460
- - Fetch Customer and YearGroups in parallel
461
- - Added cancellation token support to all read `IMasterObjectService` methods
462
- - Replace local `AsyncEnumerableExtensions` with `System.Linq.Async`
463
-
464
-
465
- ## Testing
466
- - TeamCity builds
467
-
468
- - `cv_product_auth_login` events should have `yearGroup` properties populated
469
-
470
-
471
-
472
- # Library Editor
473
-
474
- ## Code changes
475
- - Update build scripts
476
-
477
-
478
- ## Testing
479
-
480
-
481
-
482
- # Analytics Web
483
-
484
- ## Code changes
485
- - Update build scripts
486
-
487
-
488
- ## Testing
489
-
490
-
491
-
492
- # ClickView Online
493
-
494
- ## Customer changes
495
- - When adding videos to playlist, the count next to each playlist item includes archived videos in the playlist. Fixes INBOX-4415.
496
-
497
-
498
- ## Code changes
499
- - Updated query to include video with archived status
500
-
501
- - Add a preview banner in the interactive player when clicking on an item from the `Interactive videos` tab. Implements INBOX-4331
502
-
503
-
504
- ## Testing
505
- - In Online, create a playlist with some archived videos.
506
- - Go to any video list view eg. Secondary > English
507
- - Click on options and select "Add to a playlist"
508
- - The videos count next to the newly created playlist should account for archived videos in it.
509
-
510
- - In online, play a video. In the `Interactive videos` tab, click on the interactive. There should be a blue preview banner in the interactive player. For students, they should see "This is a preview of an interactive, no results will be collected.", for teacher and admin, they should see "This is a preview of an interactive, no results will be collected. Save to Workspace then share to collect your student results."
511
-
512
-
513
-
514
- # Permissions.Api
515
-
516
-
517
- # Launch.Web
518
-
519
- ## Code changes
520
- * Product name style update. Fixes INBOX-3474
521
- * Changed the width of the product name `h2` element so that longer names don't push the logos far apart
522
-
523
-
524
- ## Testing
525
- * Logo spacing in launch web looks good
526
-
527
-
528
-
529
- # RealtimeSalesforceSync
530
-
531
- ## Before release
532
- * [ ] Update `ClickView.Clients.Braze` to release version
533
- * [ ] Configure `braze` in Octopus Deploy
534
-
535
-
536
- ## Code changes
537
- - Add Braze API client
538
- - Send Braze event: `product_npjs_enabled` when the Domain option: `lite_upgrade_type_customer` is updated
539
- - Send Braze event: `product_npjs_live` when the Domain option: `lite_upgrade_complete` is set to `true`
540
- - Set Braze attribute: `product_type` when the Domain option: `lite_upgrade_type_user` is set updated
541
-
542
-
543
- ## Testing
544
- - Begin the lite upgrade for a customer and ensure that all it's users in Braze have the `product_npjs_enabled` event
545
- - Finalise the lite upgrade for a customer and ensure that all it's users in Braze have the `product_npjs_live` event
546
- - Select the `Launchpad` flow during a lite upgrade and ensure that the user in Braze has the `product_type` attribute set to `Launchpad`
547
- - Select the `New Product` flow during a lite upgrade and ensure that the user in Braze has the `product_type` attribute set to `New Product`
548
-
549
-
@@ -1,13 +0,0 @@
1
-
2
- # Before release
3
- * [ ] Update `Clients.*` nuget packages to the stable version `2.11.0`
4
-
5
-
6
- # Code changes
7
- * Remove `ToList()` for email attachments
8
- * Update all nuget packages to the latest
9
-
10
-
11
- # Testing
12
- * In NP, go to Settings->Student manager/Staff manager->Add new students/Add new staffs->Upload a spreadsheet, and then create user from the spreadsheet. An email with created users in the attachment should be sent to you.
13
-