Feature/showcase 145 by zoemaas · Pull Request #45 · 4sure-tech/credential-showcase-api

zoemaas · 2025-03-12T14:58:03Z

No description provided.

…pi into feature/SHOWCASE-145 # Conflicts: # apps/credential-showcase-api-server/src/database/migrations/0000_credential-showcase-api.sql # apps/credential-showcase-api-server/src/types/schema/index.ts # pnpm-lock.yaml

ronal2do · 2025-03-14T09:00:00Z

apps/credential-showcase-api-server/src/utils/mappers.ts

  }
 }

+export const newUserFrom = (user: UserRequest): NewUser => {


is this needed?

no this can be removed if we can map something 1:1

packages/credential-showcase-openapi/openapi/openapi.yaml

ronal2do · 2025-03-14T09:02:55Z

apps/credential-showcase-api-server/src/database/migrations/0000_credential-showcase-api.sql

We need a new migration instead of modify the existing one

Rolled back the changes and created a new migration file

apps/credential-showcase-api-server/src/controllers/User.ts

ronal2do · 2025-03-14T09:03:45Z

I've added few remarks, but looks good

Brummos

we should also update the diagram with the User Class

Brummos · 2025-03-14T09:02:19Z

packages/credential-showcase-openapi/openapi/openapi.yaml

      openIdConnectUrl: <https://auth.example.com/.well-known/openid-configuration>
      description: OpenID Connect security scheme for OAuth2 flows
  schemas:
+    User:


why does user not have an id?

Brummos · 2025-03-14T09:04:41Z

apps/credential-showcase-api-server/src/utils/mappers.ts

  }
 }

+export const newUserFrom = (user: UserRequest): NewUser => {


no this can be removed if we can map something 1:1

Brummos · 2025-03-14T09:04:49Z

apps/credential-showcase-api-server/src/utils/mappers.ts

+export const userDTOFrom = (user: User): UserDTO => {
+  return {
+    ...user,
+    identifierType: user.identifierType ? user.identifierType : undefined,


user.identifierType ?? undefined

Made it user.identifierType ?? undefined

Brummos · 2025-03-14T09:05:01Z

apps/credential-showcase-api-server/src/utils/mappers.ts

+  return {
+    ...user,
+    identifierType: user.identifierType ? user.identifierType : undefined,
+    identifier: user.identifier ? user.identifier : undefined,


user.identifier ?? undefined

Made it user.identifier ?? undefined

Brummos · 2025-03-14T09:06:20Z

apps/credential-showcase-api-server/src/types/schema/index.ts

  credentialDefinitions: string[]
  personas: string[]
  bannerImage?: string | null
+  createdAt?: string | null


this cannot be correct. createdAt is not optional and you are not allowed to pass this into a "new" object. it is auto generated

Brummos · 2025-03-14T09:08:30Z

packages/credential-showcase-openapi/openapi/openapi.yaml

+          example: 2025-03-06T11:30:16.573Z
+    UserRequest:
+      type: object
+      properties:


why is identifierType not in here?

Added the idenfierType

Brummos · 2025-03-14T09:09:09Z

apps/credential-showcase-api-server/src/database/schema/user.ts

+export const users = pgTable('user', {
+  id: uuid('id').notNull().primaryKey().defaultRandom(),
+  identifierType: IdentifierTypePg('identifier_type').$type<IdentifierType>(),
+  identifier: text('identifier'),


you can omit the name as it will take the field name by default and that one is already correct

Name omitted

Brummos · 2025-03-14T09:10:29Z

packages/credential-showcase-openapi/openapi/openapi.yaml

        '500':
          $ref: '#/components/responses/InternalServerError'
-
+  /users:


showcase can now have a user? so i would have expected some changes on the showcase

Added user to showcase

Brummos · 2025-03-14T09:11:45Z

apps/credential-showcase-api-server/src/database/migrations/0000_credential-showcase-api.sql

 	"updated_at" timestamp DEFAULT now() NOT NULL,
 	CONSTRAINT "scenariosToPersonas_scenario_persona_pk" PRIMARY KEY("scenario","persona")
 );
+


we need to generate additional migration files. so do not delete the old ones. pull in develop as we already have new files

Created new migrations files after pulling in the changes

Brummos · 2025-03-14T09:12:05Z

apps/credential-showcase-api-server/src/controllers/User.ts

+import { userDTOFrom, newUserFrom } from '../utils/mappers'
+import UserService from '../services/UserService'
+
+@JsonController('/users')


we need to have a controller test

Created user controller tests

…pi into feature/SHOWCASE-145 # Conflicts: # apps/credential-showcase-api-server/src/database/schema/showcase.ts

…itory test

packages/credential-showcase-openapi/openapi/openapi.yaml

apps/credential-showcase-api-server/src/database/schema/user.ts

…pi into feature/SHOWCASE-145 # Conflicts: # apps/credential-showcase-api-server/src/database/migrations/0003_credential-showcase-api.sql # apps/credential-showcase-api-server/src/database/migrations/meta/_journal.json

github-actions · 2025-03-24T12:41:20Z

Deployment	Resource	Location
API Server		https://pr-45-api.dev.nborbit.ca/
Traction Adapter		https://pr-45-traction.dev.nborbit.ca/

PR Deployment URLs ready for review.

ronal2do · 2025-03-25T09:26:37Z

apps/credential-showcase-api-server/src/database/repositories/ShowcaseRepository.ts


      return {
-        ...showcaseResult,
+        ...(showcaseResult as any), // TODO check this typing issue at a later point in time


the only negative point is this cast as any, but I'll move this PR

I've spent some time trying to fix it but it didn't work out, so I've just followed the pattern and appended a TODO to the code

zoemaas added 3 commits March 12, 2025 15:34

chore: Created rest API to manage users

919b9c4

chore: Made naming consistent

2a3743b

zoemaas self-assigned this Mar 12, 2025

chore: Added identifier type

2b63dca

zoemaas marked this pull request as ready for review March 12, 2025 15:08

zoemaas added 2 commits March 12, 2025 16:14

chore: Added identifier type in Open API

b55162f

chore: Reused IdentifierType enum

ed7f85d

ronal2do reviewed Mar 14, 2025

View reviewed changes

packages/credential-showcase-openapi/openapi/openapi.yaml Outdated Show resolved Hide resolved

ronal2do reviewed Mar 14, 2025

View reviewed changes

apps/credential-showcase-api-server/src/controllers/User.ts Outdated Show resolved Hide resolved

Brummos suggested changes Mar 14, 2025

View reviewed changes

zoemaas added 13 commits March 14, 2025 14:55

chore: Fixed the redundant array type return in the Open API specs

f2c8004

Merge branch 'develop' of github.com:4sure-tech/credential-showcase-a…

81cdc4c

…pi into feature/SHOWCASE-145 # Conflicts: # apps/credential-showcase-api-server/src/database/schema/showcase.ts

chore: Rolled back the changes and created a new migration file

07b3e9d

chore: Added user controller integration tests and fixed broken repos…

001efae

…itory test

chore: Removed createdAt from NewShowcase

4869855

chore: Removed NewUserFrom

e6b4fc2

chore: Added id in User and user in Showcase in Open API specs

72869d1

chore: Updated identifier: text()

556e336

chore: Removed newUserFrom call from the UserController

d12c2b4

chore: Updated UserController.integration.test.ts

a88d31d

chore: Added createdBy in showcase repository test

513c7a3

chore: Fixed broken tests

e6f4b51

chore: Fixed broken tests

2358e9f

ronal2do reviewed Mar 17, 2025

View reviewed changes

packages/credential-showcase-openapi/openapi/openapi.yaml Outdated Show resolved Hide resolved

ronal2do reviewed Mar 17, 2025

View reviewed changes

apps/credential-showcase-api-server/src/database/schema/user.ts Show resolved Hide resolved

chore: Removed User controller, User controller tests and open api specs

00dd64c

zoemaas added 4 commits March 18, 2025 10:45

chore: Changed the name to createdBy

5ac74e3

chore: Added relationship

b51a2b4

chore: Fixed type issues with the User type and updated the test cases

8b2f185

zoemaas temporarily deployed to development March 24, 2025 12:39 — with GitHub Actions Inactive

ronal2do reviewed Mar 25, 2025

View reviewed changes

ronal2do approved these changes Mar 25, 2025

View reviewed changes

zoemaas merged commit 3894b7a into develop Mar 25, 2025
6 checks passed

zoemaas temporarily deployed to development March 25, 2025 11:41 — with GitHub Actions Inactive

zoemaas deleted the feature/SHOWCASE-145 branch March 25, 2025 11:41

zoemaas restored the feature/SHOWCASE-145 branch March 26, 2025 14:48

Conversation

zoemaas commented Mar 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ronal2do commented Mar 14, 2025

Uh oh!

Brummos left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 24, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants