`clark-service-refactor` to `main` #1693

mfranz1 · 2024-02-27T17:18:32Z

This PR updates clark-client to conform to changes in clark-services. All services have been rewritten except for learning-object-service. All LOS routes are still currently being used to the old service and are referred to as legacy routes in the client.

Majority of file changes are files that have been reorganized into subdirectories of src/app/core. The core module now reflects our clark-service/CLARK-Gateway strutcures.

This pull request is linked to Shortcut Story #28112: Update clark-client to reflect changes in clark-service.

.circleci/config.yml

Cwagne17 · 2024-03-06T13:11:51Z

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"

-npm run lint && npm run test:unit
+npm run lint


I would run prettier fix here.

Cwagne17 · 2024-03-06T13:12:16Z

package.json

    "lint": "npx ng lint clark",
+    "lint:fix": "npx ng lint clark --fix",
+    "prettier": "prettier --check .",
    "e2e": "ng e2e",


We should add a script for prettier:fix

Cwagne17 · 2024-03-06T13:15:25Z

src/app/admin/core/authorship.service.ts

Should we have two cores? One under src/app/admin/core and on under src/app/core?

The way we purpose ../core/.. is to support any Angular service or guard, in addition to a few client supporting components. The unique part of and *.service.ts file in a core is not always to interact with our API, it's a client service that controls a particular component, for an example. That is the case here in admin/core where most of these service files are controlling logic for client interactions.

To fully answer your question, we should refactor to having one core within src/app however, I argue that moving every existing core to one core is a refactor out of scope of route updates for clark-service

Cwagne17 · 2024-03-06T13:20:51Z

src/app/core/access-group-module/access-group.service.ts

+      await this.http
+        .request(
+          ACCESS_GROUP_ROUTES.REMOVE_ACCESS_GROUP_FROM_USER(memberId),
+            collection,


This route won't work. The Dto for this route is expecting an accessGroup to remove from the user.

Cwagne17 · 2024-03-06T14:28:57Z

src/app/core/user-module/user.service.ts

@@ -151,17 +118,14 @@ export class UserService {
   * @memberof UserService
   */
  getOrganizationMembers(organization: string): Promise<User[]> {
-    const route = USER_ROUTES.GET_SAME_ORGANIZATION(organization);
+    const route = LEGACY_USER_ROUTES.GET_SAME_ORGANIZATION(organization);


Is this used? Should we be adding this to clark-service?

src/app/core/user-module/user.service.ts

src/app/core/utility-module/utility.routes.ts

src/app/core/utility-module/utility.service.ts

Cwagne17 · 2024-03-06T14:49:01Z

src/app/core/utility-module/utility.service.ts

+  //  *
+  //  * @returns An observable containing an array of blogs
+  //  */
+  // async getRecentBlogs(): Observable<Blog[]> {


How come this is commented out?

Clark-service supports the query recent

Patch on mfranz1 branch
Clark-service needs to be updated to look at query param not body

Cwagne17 · 2024-03-07T16:54:58Z

src/app/core/access-group-module/access-group.service.ts

+   * @returns {Promise<void>}
+   * @memberof UserService
+   */
+    async removeMember(collectionName: string, memberId: string): Promise<void> {


This function isn't being referenced anywhere

pzalep1

Looks good! Just a few comments and questions.

pzalep1 · 2024-03-09T13:56:04Z

.circleci/config.yml

-                - releases
+      - cyber4all/s3:
+          context: [AWS, Slack]
+          bucket: "clark-prod-file-uploads"


Why is this the production upload bucket?

pzalep1 · 2024-03-09T14:03:26Z

src/app/admin/components/user-card/user-card.component.ts

@@ -89,7 +89,7 @@ export class AdminUserCardComponent {
  }

  async canAddEvaluator() {
-    const roles = await this.privilegeService.getCollectionRoles(this.user.id);
+    const roles = await this.accessGroupsService.getUserAccessGroups(this.user.username);


Not using id?

pzalep1 · 2024-03-09T14:04:28Z

src/app/admin/components/user-search-wrapper/user-search-wrapper.component.ts

@@ -73,7 +73,6 @@ export class UserSearchWrapperComponent implements OnInit, OnDestroy {
        this.loading = false;
      }).catch(error => {
        this.toaster.error('Error!', 'There was an error fetching users. Please try again later.');
-        console.error(error);


Thank you for cleaning these up.

pzalep1 · 2024-03-09T14:06:29Z

src/app/admin/pages/users/users.component.ts

+      })
+      .catch(error => {
+        this.toaster.error('Error!', 'Could not remove reviewer. Please try again later');
+        console.log(error);


pzalep1 · 2024-03-09T14:07:54Z

src/app/auth/register/register.component.ts

  private ngUnsubscribe = new Subject<void>();
-  ssoRedirect = environment.apiURL + '/google';
+  ssoRedirect = AUTH_ROUTES.GOOGLE_SIGNUP();


pzalep1 · 2024-03-09T14:16:50Z

src/app/core/collection-module/collections.service.ts

+                c.hasLogo = true;
+              });
+          } catch (error) {
+            console.log(error);


pzalep1 · 2024-03-09T14:18:25Z

src/app/core/feature-module/featured.service.ts

@@ -130,22 +133,22 @@ export class FeaturedObjectsService {
   * @returns {Promise<LearningObject[]>}
   * @memberof LearningObjectService
   */
-  getNotFeaturedLearningObjects(query?: Query): Promise<{learningObjects: LearningObject[], total: number}> {
+  getNotFeaturedLearningObjects(query?: Query): Promise<{ learningObjects: LearningObject[], total: number }> {


It is used on the featured admin page. It gets the learning objects that aren't featured.

pzalep1 · 2024-03-09T14:18:47Z

src/app/core/interceptor/httpconfig.interceptor.ts

@@ -20,9 +22,10 @@ export class HttpConfigInterceptor implements HttpInterceptor {
    request: HttpRequest<any>,
    next: HttpHandler
  ): Observable<HttpEvent<any>> {
+    console.log('intercepted request ... ');


pzalep1 · 2024-03-09T14:23:59Z

src/app/core/library-module/library.service.ts

@@ -113,7 +116,7 @@ export class LibraryService {
    // Show loading spinner
    this._loading$.next(true);
    // Url route for bundling
-    const bundle = USER_ROUTES.OBJECT_BUNDLE(
+    const bundle = BUNDLING_ROUTES.BUNDLE_LEARNING_OBJECT(


History: Library used to have a download button and we used to bundle everything on the fly.

pzalep1 · 2024-03-09T14:24:35Z

src/app/core/metric-module/metric.routes.ts

+   * Request to get all learning object stats
+   * @method GET
+   */
+  GET_LEARNING_OBJECT_STATS() {


This is probably related to the weird 2 stats routes we had in library and learning object service.

…revision-of-a-released-learning Bug/sc 32660/cannot create a revision of a released learning

…hanging-author Bug/sc 32638/404 error when changing author

should i be surprised this would eventually break? Signed-off-by: Andreas <git@fsck.rip>

Signed-off-by: Andreas <git@fsck.rip>

This reverts commit dcc3065.

…learning-outcome-response-to Parsing for the new create-outcome JSON response

…to' into bug/sc-32563/deleting-a-learning-outcome-doesn-t-seem Signed-off-by: Andreas <git@fsck.rip>

…arning-outcome-doesn-t-seem

Signed-off-by: Andreas <git@fsck.rip>

…or-posting-response-but-it fix: [sc-32663] Client shows error posting response but it actually added

… directory