-
Notifications
You must be signed in to change notification settings - Fork 13.8k
chore(apps): consolidate accessor implementation to runtime (2/4) #41377
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4677882
refactor(apps): Phase 1 - port Reader family, Persistence and server …
claude 9605a15
refactor(apps): Phase 2 - port Modify family into base-runtime
claude 0475207
refactor(apps): Phase 3 - registration + app-settings surface via App…
claude 8928e1a
test(apps): address PR review feedback on base-runtime accessors
claude 167524f
docs(apps): track createProcessorId endsWith fix as a follow-up
claude 7deb704
docs(apps): track deferred parity-preserving review findings as follo…
claude File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
44 changes: 44 additions & 0 deletions
44
packages/apps/base-runtime/src/lib/accessors/Persistence.ts
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| import type { IPersistence } from '@rocket.chat/apps-engine/definition/accessors'; | ||
| import type { RocketChatAssociationRecord } from '@rocket.chat/apps-engine/definition/metadata'; | ||
|
|
||
| import type { RemoteBridges } from '../bridges/RemoteBridges'; | ||
|
|
||
| export class Persistence implements IPersistence { | ||
| constructor(private readonly bridges: RemoteBridges) {} | ||
|
|
||
| public create(data: object): Promise<string> { | ||
| return this.bridges.getPersistenceBridge().doCreate(data, 'APP_ID') as Promise<string>; | ||
| } | ||
|
|
||
| public createWithAssociation(data: object, association: RocketChatAssociationRecord): Promise<string> { | ||
| return this.bridges.getPersistenceBridge().doCreateWithAssociations(data, new Array(association), 'APP_ID') as Promise<string>; | ||
| } | ||
|
|
||
| public createWithAssociations(data: object, associations: Array<RocketChatAssociationRecord>): Promise<string> { | ||
| return this.bridges.getPersistenceBridge().doCreateWithAssociations(data, associations, 'APP_ID') as Promise<string>; | ||
| } | ||
|
|
||
| public update(id: string, data: object, upsert = false): Promise<string> { | ||
| return this.bridges.getPersistenceBridge().doUpdate(id, data, upsert, 'APP_ID') as Promise<string>; | ||
| } | ||
|
|
||
| public updateByAssociation(association: RocketChatAssociationRecord, data: object, upsert = false): Promise<string> { | ||
| return this.bridges.getPersistenceBridge().doUpdateByAssociations(new Array(association), data, upsert, 'APP_ID') as Promise<string>; | ||
| } | ||
|
|
||
| public updateByAssociations(associations: Array<RocketChatAssociationRecord>, data: object, upsert = false): Promise<string> { | ||
| return this.bridges.getPersistenceBridge().doUpdateByAssociations(associations, data, upsert, 'APP_ID') as Promise<string>; | ||
| } | ||
|
|
||
| public remove(id: string): Promise<object> { | ||
| return this.bridges.getPersistenceBridge().doRemove(id, 'APP_ID') as Promise<object>; | ||
| } | ||
|
|
||
| public removeByAssociation(association: RocketChatAssociationRecord): Promise<Array<object>> { | ||
| return this.bridges.getPersistenceBridge().doRemoveByAssociations(new Array(association), 'APP_ID') as Promise<Array<object>>; | ||
| } | ||
|
|
||
| public removeByAssociations(associations: Array<RocketChatAssociationRecord>): Promise<Array<object>> { | ||
| return this.bridges.getPersistenceBridge().doRemoveByAssociations(associations, 'APP_ID') as Promise<Array<object>>; | ||
| } | ||
| } |
26 changes: 26 additions & 0 deletions
26
packages/apps/base-runtime/src/lib/accessors/environment/EnvironmentRead.ts
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| import type { | ||
| IEnvironmentalVariableRead, | ||
| IEnvironmentRead, | ||
| IServerSettingRead, | ||
| ISettingRead, | ||
| } from '@rocket.chat/apps-engine/definition/accessors'; | ||
|
|
||
| export class EnvironmentRead implements IEnvironmentRead { | ||
| constructor( | ||
| private readonly settings: ISettingRead, | ||
| private readonly serverSettings: IServerSettingRead, | ||
| private readonly envRead: IEnvironmentalVariableRead, | ||
| ) {} | ||
|
|
||
| public getSettings(): ISettingRead { | ||
| return this.settings; | ||
| } | ||
|
|
||
| public getServerSettings(): IServerSettingRead { | ||
| return this.serverSettings; | ||
| } | ||
|
|
||
| public getEnvironmentVariables(): IEnvironmentalVariableRead { | ||
| return this.envRead; | ||
| } | ||
| } |
16 changes: 16 additions & 0 deletions
16
packages/apps/base-runtime/src/lib/accessors/environment/EnvironmentWrite.ts
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| import type { IEnvironmentWrite, IServerSettingUpdater, ISettingUpdater } from '@rocket.chat/apps-engine/definition/accessors'; | ||
|
|
||
| export class EnvironmentWrite implements IEnvironmentWrite { | ||
| constructor( | ||
| private readonly settings: ISettingUpdater, | ||
| private readonly serverSettings: IServerSettingUpdater, | ||
| ) {} | ||
|
|
||
| public getSettings(): ISettingUpdater { | ||
| return this.settings; | ||
| } | ||
|
|
||
| public getServerSettings(): IServerSettingUpdater { | ||
| return this.serverSettings; | ||
| } | ||
| } |
19 changes: 19 additions & 0 deletions
19
packages/apps/base-runtime/src/lib/accessors/environment/EnvironmentalVariableRead.ts
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| import type { IEnvironmentalVariableRead } from '@rocket.chat/apps-engine/definition/accessors'; | ||
|
|
||
| import type { RemoteBridges } from '../../bridges/RemoteBridges'; | ||
|
|
||
| export class EnvironmentalVariableRead implements IEnvironmentalVariableRead { | ||
| constructor(private readonly bridges: RemoteBridges) {} | ||
|
|
||
| public getValueByName(envVarName: string): Promise<string> { | ||
| return this.bridges.getEnvironmentalVariableBridge().doGetValueByName(envVarName, 'APP_ID') as Promise<string>; | ||
| } | ||
|
|
||
| public isReadable(envVarName: string): Promise<boolean> { | ||
| return this.bridges.getEnvironmentalVariableBridge().doIsReadable(envVarName, 'APP_ID') as Promise<boolean>; | ||
| } | ||
|
|
||
| public isSet(envVarName: string): Promise<boolean> { | ||
| return this.bridges.getEnvironmentalVariableBridge().doIsSet(envVarName, 'APP_ID') as Promise<boolean>; | ||
| } | ||
| } |
36 changes: 36 additions & 0 deletions
36
packages/apps/base-runtime/src/lib/accessors/environment/ServerSettingRead.ts
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| import type { IServerSettingRead } from '@rocket.chat/apps-engine/definition/accessors'; | ||
| import type { ISetting } from '@rocket.chat/apps-engine/definition/settings'; | ||
|
|
||
| import type { RemoteBridges } from '../../bridges/RemoteBridges'; | ||
|
|
||
| export class ServerSettingRead implements IServerSettingRead { | ||
| constructor(private readonly bridges: RemoteBridges) {} | ||
|
|
||
| public getOneById(id: string): Promise<ISetting> { | ||
| return this.bridges.getServerSettingBridge().doGetOneById(id, 'APP_ID') as Promise<ISetting>; | ||
| } | ||
|
|
||
| public async getValueById(id: string): Promise<any> { | ||
| const set = (await this.bridges.getServerSettingBridge().doGetOneById(id, 'APP_ID')) as ISetting; | ||
|
|
||
| // The host accessor checks `typeof set === 'undefined'`, but across the RPC boundary an | ||
| // absent (undefined) host return is serialized as null, so both must be treated as "not found". | ||
| if (set === undefined || set === null) { | ||
| throw new Error(`No Server Setting found, or it is unaccessible, by the id of "${id}".`); | ||
| } | ||
|
|
||
| if (set.value === undefined || set.value === null) { | ||
| return set.packageValue; | ||
| } | ||
|
|
||
| return set.value; | ||
| } | ||
|
|
||
| public getAll(): Promise<IterableIterator<ISetting>> { | ||
| throw new Error('Method not implemented.'); | ||
| } | ||
|
|
||
| public isReadableById(id: string): Promise<boolean> { | ||
| return this.bridges.getServerSettingBridge().doIsReadableById(id, 'APP_ID') as Promise<boolean>; | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.