Feature/integrate xp api: GetXpUserMeta #572
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ng of UUID strings to non-UUID strings
…feature/integrate-xp-api
…feature/integrate-xp-api
…feature/integrate-xp-api
…feature/integrate-xp-api
This commit adds (separates and abstracts from existing impl) the interface, which represents a memory lock store used to store and enforce locks in memory. It includes a method to acquire a lock for a given ID with a specified timeout.
The word aquire has been corrected to acquire
This commit adds the XpStore interface and related interfaces for managing XP accounts, users, contracts, invoices, and account entries. It also includes the implementation of these interfaces in the MemoryStore class. The XpStore allows saving and retrieving XP accounts and users, as well as performing transactions and accessing meta data associated with users in the Xp system.
This is a WIP commit, no errors but lacking viability/relevance in relation to codebase
This commit adds the implementation of the createXpAccount and createXpUser methods in the XpController class. The createXpAccount method creates a new XP account with a unique ID and initializes it with default values. The createXpUser method creates a new XP user with a unique ID and associates it with an email address. Both methods are asynchronous and will be updated but are not yet fully able to perform the necessary operations to save the created accounts and users in the XpStore.
…feature/integrate-xp-api
…feature/integrate-xp-api
This commit adds utility types and functions for object manipulation. These changes contribute to the codebase by providing reusable utility types and functions for object manipulation.
…feature/integrate-xp-api
…feature/integrate-xp-api
… user retrieval and creation
…nd integrate getUserMeta into RecordsServer
…db.UUID type for xpUserId; create migration scripts for new XpSystemEvent and XpSystemEventAdjustment tables
…feature/integrate-xp-api
…feature/integrate-xp-api
KallynGowdy
requested changes
Nov 19, 2024
Comment on lines
+2143
to
+2179
| getXpUserMeta: procedure() | ||
| .origins('api') | ||
| .http('GET', '/api/v2/xp/user') | ||
| .inputs(GetXpUserById) | ||
| .handler(async (input, context) => { | ||
| const authUser = await this._validateSessionKey( | ||
| context.sessionKey | ||
| ); | ||
| if (!authUser.success) { | ||
| return authUser; | ||
| } | ||
| if (!input.userId && !input.xpId && !authUser.userId) { | ||
| return { | ||
| success: false, | ||
| errorCode: 'unacceptable_request', | ||
| errorMessage: | ||
| 'One of properties userId or xpId must be provided.', | ||
| }; | ||
| } | ||
| if (input.userId && input.xpId) { | ||
| return { | ||
| success: false, | ||
| errorCode: 'unacceptable_request', | ||
| errorMessage: | ||
| 'You cannot provide both userId and xpId.\nProperties are mutually exclusive.', | ||
| }; | ||
| } | ||
| //* An empty string for any of the query types will be treated as the current logged in user | ||
| const user = await this._xpController.getXpUser( | ||
| input.xpId | ||
| ? { xpId: input.xpId } | ||
| : input.userId | ||
| ? { userId: input.userId } | ||
| : { userId: authUser.userId } | ||
| ); | ||
| return user; | ||
| }), |
There was a problem hiding this comment.
@LandonSiler If xpController is null or undefined, then this procedure should check that and return a not_supported result just like the getNotificationsApplicationServerKey procedure.
| }) | ||
| ) | ||
| .handler(async ({ contract }, context) => { | ||
| const authUser = await this._validateSessionKey( |
There was a problem hiding this comment.
@LandonSiler This procedure should check to see if the xpController is supported as well.
| { contractId, newStatus, newDescription }, | ||
| context | ||
| ) => { | ||
| const authUser = await this._validateSessionKey( |
There was a problem hiding this comment.
@LandonSiler This procedure should check to see if the xpController is supported as well.
Comment on lines
+40
to
+42
| beforeAll(async () => { | ||
| initServices(); | ||
| }); |
There was a problem hiding this comment.
@LandonSiler Technically this isn't needed because the services are being initialized before each test.
Comment on lines
+99
to
+101
| (await this._xpStore[ | ||
| `getXpUserBy${id.userId ? 'Auth' : ''}Id` | ||
| ](id.userId ?? id.xpId)) ?? null; |
There was a problem hiding this comment.
@LandonSiler Please prefer regular dot-syntax for choosing which store function to call. IMO it will be easier to read and also won't require constructing a new string just to call a function:
let user = id.userId ?
await this._xpStore.getXpUserByAuthId(id.userId) :
await this._xpStore.getXpUserById(id.xpId);There was a problem hiding this comment.
Absolutely 👍, I believe my initial plan with the dynamic accessing was to support multiple forms of Id querying which weren't implemented in any capacity outside of auth and xp Ids', this is/was a YAGNI moment :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several changes across multiple files to enhance the functionality and configuration of the xp api within the project. The most important changes focus on updates to the
MemoryStoreclass, integration of XP features, and the addition of the XpController.Enhancements to
MemoryStore:XpUser,XpAccount,XpContract, andXpInvoiceinsrc/aux-records/MemoryStore.ts[1] [2].saveXpAccount,createXpUserWithAccount,saveXpUser,saveXpContract, and various getters for XP entities insrc/aux-records/MemoryStore.ts[1] [2].Integration of XP features:
XpControllerand integrated it into theRecordsServerclass to handle XP-related requests insrc/aux-records/RecordsServer.ts[1] [2].getXpUserMeta,createXpContract, andupdateXpContractinsrc/aux-records/RecordsServer.ts.Development environment settings:
.vscode/settings.jsonto include preferences for JavaScript module specifiers and spell-checking custom words.docker/docker-compose.dev.ymlto use a configuration file for Redis and updated the Redis configuration indocker/conf/redis.conf[1] [2].Additional updates:
jakefile.jsto update the path for thetsconfig.jsonfile in thegenerate-stub-projectstask.src/aux-records/TestUtils.ts,src/aux-records/Utils.spec.ts) [1] [2] [3] [4].These changes collectively improve the project's functionality, particularly around XP management, and enhance the development environment configuration.
Closes #506